From dbce8d603495e6363766716d32843b7b9e6efc68 Mon Sep 17 00:00:00 2001
From: Johan de Klerk <johan@shiplogic.com>
Date: Thu, 10 Aug 2023 08:24:24 +0200
Subject: [PATCH] Added readme on how to install as a private repo

---
 .DS_Store  | Bin 10244 -> 0 bytes
 .gitignore |   1 +
 README.md  |  24 ++++++++++++++++++++++++
 3 files changed, 25 insertions(+)
 delete mode 100644 .DS_Store

diff --git a/.DS_Store b/.DS_Store
deleted file mode 100644
index 79f262438848dcd071097fbbc6fb8af739044c11..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001

literal 10244
zcmZQzU|@7AO)+F(P+(wS;9!8z0z3>@0Z1N%F(jFwA}JvA7#IW?81flX7*cc64TF>O
zp>m_tXb6mkz-S1JhQMeDjE2DA3IRrlb2zvm^e8zR0;3@?8UpYT0F@7*4g!dFfVA-$
z8Xz=Ch=GxT0o(;(WME){X<`KT0~kPZAgv%8q!mPiv@$S)SYR{2S{WFjS{cFJ5Rg6r
zuu+WQt_g?_*3Q5PwwZx}5o|L910zH`10&RCMraR(5u%-e5o|jH10zH`*vwI4Gz3ON
z05t?aeRp;SJ%%!dVuobo{(Ei#L?II>qoJwD&3AE0%E?ax4IW5o$k(c_J?zN9z<{AD
zg$Pvz8KBVum~G(P%gd0+kiw9{P{feRP|Q%w5YJG`P{NSOki$?68C!s<=C@;DV8Ejq
z*`0?h;O@k$1L0=kbYOA6AVVTU0YfH3JVOdYK0`7?DMKzpDnlMa2}2^-ANdS<sQwT*
z$iTorgf3+N6zuWN-v9}BqI4qsMVd}j|A9+Y4!Hkv81fm?(PKqnD=1x{t3h`A)5RaZ
zY~2V>GZ<#&<|AB+PaUee3_yt$6t9qQhoqbWhJ1!RhGI}ELJe=pI%vAVp&Hq(lg`1z
z8ISqMt|m?gs{6s=%F2+)P|A?PkjYSj>R#Rm1_lNsS!DMux&(J0iV8$1VpoA`KRDm9
zgG+#PhCGl981hlwAQS-3;h-`Ct^(N|_in)5fo2YJ*x*)$>K<@-K+MTyC}2ngl?ABo
zVfhJn4_pPZdlc`Xxd%xVB5ZK0!r~q-h7@oPPQ_g!afUN6Fkn@O?6%eg@br&EEy9I_
z)S|i*9FJV!(k7Xqh@q090DFnUxDM=2P^pBb4%wZBPvBvQ)lB4=C8QRMJJ}dg8HyN+
z81fm4(94isP>F~lkL<3~q6)A&2Tctk+;FKub;kinxskz;$dJd7!jJ=Y5zhL?I22rN
z;8cz5#urEJ4noT~UIsim5H2Q82deuMK<;N@z*-JFyk!72%%O6~Zd=9U1FJjWdXeK2
zn>?z$;Kl(DLms$pOTr&&jN2F(7;vgZc2}?f++BFoBSMTA^{DO!=MPp;X#y^1(b^My
zx54EssP+Jr!o|pL;}wRx4M{(8s9{%u#eOcZ{b}ITmW(}rnr;H;PmoK{)FHdcRSfPX
ztY#v+j*wbZcY+Fg22QX$iy3g%qx^9U4A@j5yD?M}?nW%;A-fR2N>ulO<B^G>n86se
zR*-$h0P2($GZ-Vgp-%?x2CyDvThZlE?E%+AY~VHos18bI$UwF4EXW}!^2qicp9?SN
z(bOQ)FfKJH?qCGBZ}`FP0F~FN3?<-paW1&rN@Pd}<v>)I2_!NwFc8pz?AA+`@Gv5%
z3*ma=b)onN(z)kmC}zlE$Ye-nz*D0#U1eZkz@ZY^{mGh&usQ*!YJ|H9t44J%D4H3V
z8HyPS(Q7L1`wR>)8D#g=+QY*Wst-BUVaj5$kB6a{p@gA`A(J7GAsu&{Ln0YmzT!}e
z>?YTe$CoA7gWKIW%|>=5G3rs>4IXWQnO({ND&26_rlC)f+>N0Y+1=OwsQrf4r8vz-
zb~iEVQQZw5n_|V)&lF$>*9-7oD6-p{LgDd@q#xNe*j1p~4=!gwbvZpTGsH3l(D=VA
z0|T!4e~7A4ax?@+Ltt2j03(Y_u!|FTP#(MgKtq6_5(?bgfT{zPn2ezDc?ch*1T?e{
z9*$>%EGp6fna0S#0B*cM+29I-kpVKAKVXvq@Nvn}{yzh#J&80<fLyl`>eD0Fa)i{P
l)_36c6iVM6we>pM{|C41v5ZKdh9fvf!u#;3VTix~4*=UXRV@Gj

diff --git a/.gitignore b/.gitignore
index fb6d4c2..670b35a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -17,3 +17,4 @@
 examples/core/api/api
 examples/core/cron/cron
 examples/core/sqs/sqs
+.DS_Store
diff --git a/README.md b/README.md
index b09bb79..e8f6ef0 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,30 @@
 A set of utilities used by our Golang projects
 * [errors](./errors/README.md)
 
+## Install this private repo
+
+Add this in your `~/.gitconfig`:
+```
+[url "ssh://git@gitlab.bob.co.za/"]
+	insteadOf = https://gitlab.bob.co.za/
+```
+
+Run this to reset the go proxy
+```
+go env -w GOPROXY=
+```
+
+Set the private go module path
+```
+go env -w GOPRIVATE=gitlab.bob.co.za:bob-public-utils/bobgroup-go-utils
+```
+
+Run this in your project to add the private module
+```
+go get gitlab.bob.co.za:bob-public-utils/bobgroup-go-utils
+```
+
+
 ## Creating a new release
 When making changes, a new release needs to be made in order to use the updated library in your project.
 
-- 
GitLab