From 7a836b04b64c05b3095acd4da8f87b50e044b140 Mon Sep 17 00:00:00 2001 From: Chris Anderson Date: Sat, 25 Mar 2023 14:25:15 -0500 Subject: [PATCH] Tweak to readme --- .env => .env.example | 0 .github/assets/logo-dark.png | Bin 0 -> 7297 bytes .github/assets/logo-light.png | Bin 0 -> 6941 bytes .gitignore | 2 ++ README.md | 26 ++++++++++++++++++++------ 5 files changed, 22 insertions(+), 6 deletions(-) rename .env => .env.example (100%) create mode 100644 .github/assets/logo-dark.png create mode 100644 .github/assets/logo-light.png diff --git a/.env b/.env.example similarity index 100% rename from .env rename to .env.example diff --git a/.github/assets/logo-dark.png b/.github/assets/logo-dark.png new file mode 100644 index 0000000000000000000000000000000000000000..3e40a3dc95bb97aca04c3529da02a203cb5c59f5 GIT binary patch literal 7297 zcmXw81z1$g*I!ZzLApa~>5^PRx=WB{SyD<$0a*oPX_S&sx+DYysa@$@kOt{)L}~%) zhJ|l^pYK1;T?OSmHEe-@NQjBAE4AjlJ#(I!X{IH<=RpqVMLO(NcX#$JdkN0U&(zC^rt zl##2+>89bU48SiumyKYMn~G!ugy;hB)gu3wc&SXSPA%p=<^$cr|It==3BVEb&J@`6 zh?S`9|4YGb(IK>0(x|1D*gOR836{W=>29 zCauOw+iD)9hp^1?|Hl9oF9#w()u#XPRC7T+Y~MJS{>N7A)R@(_JyN^;g$S$UsSvCo zWHN6)&|3v7OoC1!2isOIK7!SePgTM7h^1So1zo3cG%Ppsx9)qjmP3i}K;}?Y>RjEn^@p z2S_*I(wnoR!y}dwmIJ7S4>TejC%SL$QkVcSU<)@!Y zkwa}LuF$JCoe#91G>&FZ=Z|k)HZDuRrK*@i1$5BOgohy)$`n=8F9tP%fUM5v%SoqS zm#XS=VHeSFoS=-xIm8szGMcCEAY2DE&n-NyvsEbgw=^+D?(G~P0|rP}vX;r6}OKyVexBCJV8Qm zUwL>4m|q$rdDFS0rKTp?L}x38=zqmcT5XKD9I9>ppr-b$v=S$U?2k7+B)RHylagEC zrWg>Yn$WeQsiro`V1ZzKZYvp)Oj<5R-E%sB?-2*bcfARDNN~0&BEPxJ!e0n$9Gc6z zHDqEi_sh7^yn&vSXNW?Y*Mz3EmIM2^g3Ih3ezJWid_$on9q4r;N-+_JzAhS;W@}g= zqo6QVk670>o^iz-LuSt_F}EWPc~kz=rIQkjeC(^1Rm1Az`>W=tMXtsa@5(AIHFBe& zFm*a!Q@ZECPgWrs5$TQIJ_OL1)T!S+=H4laxdS< zIv_z2Aw+6uTZ02~p0JifYsbleTN;2le~URQCH>Rj%%Lm50421C2&7;=Ek9kK2=TU6 zJp43yg@hqg0O;rLaKFqN3gB{tB9q@Wmd*9oSX>>s&jHZ6{?B-@BD zZLEm6>aR=as%;*@Vanw0u*fX7!J5$735hc$%oBXLC|&n?NyCY_?CjFZ*}RcMtcA;%XSh7k2m=GL)_&a2YI`{)0Q7qMSsL+LMR$a#8@pdeKkC3Jx@)al&MLPz!^!IR z!#57+k?^Gv{gGDS~lGY_JN;!Adq#FI+jUT2H^zv2EQ8 z>WK>gcFY$lk7r&GKbFW1=O46OW_kVchOt$SVQ=4n^60uwc4YTkw#`9@$z4-6smM3{ zZ=+doZkOq~q3NMX9MrYs$middPlR9gc3B5M{GPeP-0uG}N#cH7i^xsOmHFN>9bY_2 zqo(6?w66zRX{XynkLpL_tv6Fwd0|4JO}U+cwZkAx=-b%yMa{@(Du?h19S)3-0=iBb za~5CZRSF!lM9Qz>+g=m4UPF&8Gc_njPFx<(ZHrdtG2U8w+#m~2v?FddxW3+APxmS- z94Sag&-Uw$cu%RVr))HdypmjOiLuU<9j7P{s*SKo5NLCyIaVf)lGzLr5Afh5*!qE2 z79X8%X@oY?Y8i*WIt|g$N9uHjY`({blu|8^yJl(dj64$Qk#Ej}vhec*ACJP59Y?(< zVK^yP@#eVil2*@qba+O7oOfaKdRUfYTBLzik9*hxjYq#Ea%Wf>=6s~u^8v#rk;;bu zxP-51n62`PjkaJ>OR+StYAVeBS}9}58}yDDBZf+Bc8luAyT&lO_a;d36$Qw4^@#>8 zgI_q0&J9Gk_2mGwe)(49!KEiXLis+K?TzN0PUE1)y2xVE(XI89d8gyr_&IS~%n@4& zU;3znwD+w+8}OKiu~NEm0f=8)_{UG3g`KUVi4kyR$B+(xKB~1D#ih%iUO9;%xX*(t z`Y!<9EXuKm2yoC;kcp0k~SgE{LX59Gicx|n%=oj_Y&FL*Edp=373z&8)D@D^(paDuTEeEQLbOU zgY<8xs3&H1=SRj~jK(VNQQgYsoxpnT`l3&Zrz8O++abRr*s>I6FK}Oi$_O+aNc2bQEcR-@7c!?PXEPXh@b-@2Mt#k=d+2hKyLCo_UEq1S9?kyQn!)s!OUzBmc zj_t|F{>i0+H^vc2f}Lz?u$QOgRR)+3H@*d)#!=4*Y+$LQUf-rS0+o==l}o+pt4-t} zRNqg~R@mGwx+l|qOq>xXM!s0Afw(?&&N9*uP99UXo$Qss>KKN4=7a>#e8JD2C@k7b zJ1jw|g`C9(;kgN&dW)~+ITMAJW|Ml@JlU^fyKeTFA8#4F4P3v&)O3<}d5Rxen(P?v ze6_`KFtJULxKg6O;aRj?JfX-UC1=Z#!;#Djn>h zm7zuB2k%We$3IqnL?t~R{N?YkWtRy>4n7Eo>4u3{bL^c-U0?U9Ox$BOvH0cwgy|5? zp}OLgCj8_&=#F<>f~sezoLjiJ?oZ%SPTb4=^3rvrHQ;XlOm-mtt^SDF+TeuuAkIrn z@7o)Su=%iWP6t-KZs|^fm4V4O>&Yx0MhTQ+ry5i3d(o9jhWH5*aEu^ zFV)A83}P*2(N}xkFFs}=%Wj)9uFd7$sb(g7nv)0GeL1!^nI29)`q^=fBLLlFd~nfZ z?;&A7z-`-WE=v;GKKZRJpp%yItz}|Pu;ky517r(6{eaTR@I>S7gfpa|XZFO)T-8SS zh>YiX`f9RMX;hCg+H!=5!P<@*Q<>Vne=KA4hI8$rE z8@Ct?-NK%L+Qck?ejO)}eQ z+t(ZyyBvEL{p}C>H)&%6cA|vXiAJRxGuS@raTxqL<%*m{&jnlkynKE0s@x&AmXo<2 zg}sbGDaY%l1W1T~G*jn#Sv9z=Tw8R>^l2TcCoP99=LoeOEu&07CWgQMYx8HIR4}Yf z^0*_yZd&ZS+imBqMOS@K>;Cc&00{pPA0hXXjmp5LjodT24B?CUoY=)aQ4?8^?j9d- z8aYw#!sZUxIJUgZzq1xV?8eX9JThD>XQ?Wndz^MFc@!<@EYtzl&|(dEgoF2qCMfyI z^?;NVp!JEc-0jG5z-UllK=Si<*;;3{K6vmz?x>|_rf^UHksqF))=hz`e#zWcaKCkY zxe6~H%$v3sFF)LB{A6GD|GXMD-%;c_relGS2#T5HHTQ}5@|0vM6kkE#&9byphj`=y zzSoA)b7|LE;@Xerd+HPPJRqr!31q@mEPc?o9B&pn7a;)1L`L&M_$&xy#g+wZ%|G@dY{l5-E+_W)jw*dOl<9mv5ATAxUi{=wrq@*O`ad-qJ{KycOP_1t~1Ikc@Q z@xG#r>d`(KeRL?%hh+qKH z08lJw9=WJ{WEQFn4f(Wl^i-_RY_>?FERfqjW|g+CM7yq98PA z0Pae{-uSDXXUx%wmdTa~>>^AsC!S^132?8L8_3onNb|6BN!cl9wSb7TRa0d9U(dp3t_+u_ zXgnsO91nN6%kR;{#^_2m21)W2V<^Hnt|xCGY$LS+uPg(%+2ClkrP+P5$fh$q`B8`o zXIfhNMJmiN*KzU=f6c662J2TxV?Uuk)$3HISh2sn`P3uu$Mcy_DJq>sSUyV`r2J(b zsGJ){D;${9iO#SvEU?Noy#vw%kG(>ptg;wfl!^UZaLhMcfS+9dayXc=7lv=-y%5il zJy*ErtV8NHhsyAX`%waFhosWnblO0GG%;z2G2G%sWKbmi0&7#;nry1sQ=VU7s z(6gPyb5J$Nd48+&^Dlgw_Sdk6$2EERi%m-ylTc-TMbx<*0!4RqK#DQviB#aJjS4-Z{JJ0Kh z^+M1})zhjpU?`zacIUj7FDNc-aX*TFL6MKe98nQ`nA$~r}~0VR%s)c$7P z#SeS-x}>`8?02WnBg2C&!SfT*f~LJ0CN}}1R6AEfSl+${amZw!g zEPJo!IFm>t|9hrhOpwto@End8tzYSh;Zuo|oJ>7K0oJ@Ume@}Yvt8lP~ z!WO>$d&}AsXwYyLBYgnT2vEbHzb2wd&~O)oFX_B9DSY6)l?ddIpk?(GH`33n~n=f`Qkz{MGxV- z?ZhN#5F6Fn1{AI&o_tw*pJJE@{^qr!==QSx$2I@Pm#c!PFmjeJZ|&m>an6vYdS~pG zhbct&;65}$kXs0Jkke21Yj=%ZI`g{eZosGN(|$HxcRz}s+BzA+ZHzU`%W;D3jM4h&$A0QHKJp^eVP8D- zalr11{(45|o@?wPG1-r;a%Xr>N-h-Hg+B7}+nlp!KU3O{KP-09a|4eY{-$U`Z$cbR@YY{*|bEii~ zeDne=IKEwd)PL48=_|GvmDf}I5%!D_vOIbdGFkiyHwkA-0aQLBT26NPXYJQ2XpLK- z*q9K^2?UhOv_;Fes+N-(?hSJVFXub}<-E?(tPwghk;D4kRQ?)0zM#= zy`;Wr4gGowTU5{KHX_`P-_aRLLb0BOszgiFo>WaA-+jKWT)E@wfbkd{trvdl4c249 zs+=-SMNhtN&hPsOwJH5sa5U8OySUFpjWHG<&%6Hq2@OL1O*MPVcEjGG zKyl(pxq>#`ct6Y8U)9sBCw4yB>Ywhrp|mqCODCl;-R9Z}*zpIE>R4Sd!C%nXriUkM zze*%oSHoFXZC`_UfwZZNTK9(O_RdO#+Qf;DA!kZIFT@w(X0|We#{~>s%HYF4mf|g_&7{pG+dZ8>%f zJ_VEmd*`nHxP&ZwtuzR8v>o+8y&Zp~gu{5_6Xz1~v<-O{CrmaYV3B!o)Bju@ z_{J~$suiHu;Bm`4Cg~fU;x_6kdARfW-E$#uM3N8$c=`?g_42q!tb9*FneT19>;W^~ zcxa8`H?D71X@Y6sF7X0H@VbnnYD2cF>9i;L={TBs+VXf}$e_sH>wj)}kngk9X= zfE1EfXR}45tn7RK(0F|W!gcIW4(gR#NLse{lo0YTr>K0RCeUFyFAD%`$4MFe-6}l$ zbA0=w5Dm2TsQO4yyL7VMZ-UuY;i+ZqskZ%=QERIE`l4%qBVJ=}mAUrc>U9bDfs6^lFU@D)K zjpOd`%eS24!0>7q#)LR)e+ffX0Gq{I@(vo3Nt1*8ytV^&1RzTqhK~J6OaA;Ye3
)GO_&GK~J4u6u9bnqjHiiv1o%s!0;&?)YU~CXM*#!Q}oO4qnmBLvJfdy)yfG(Sb zbVu`6yXqmOm=GFlKsl6`Rkv)7(wQZM7Eb^h$$mdd{LQI2Ziwptd+<8$n92zKuO=Fs zCT}5-&0fnpNawtGgiA$1A(TlbK(2I(8e!4LlEnY10g*==4z7f^NY^1JT3s>L+eP(uxQm#{A#(`w90ccuFAEFO~K9!LGd&WZ!w+IK4|Dq67+0tH2YA)O48*8=gc;q6vtaAxc2f4~$L z+c_*@V8jODIr9Hd=RlH79{-c2z>|OK%8gwgHCUFguiaC!*FY=-w1wi=zHw9#36|q& mc4Oc?AV*VC_aB$;QP4v%V+dM*)&`3h0<_f))GAbLL;nx4t}0*v literal 0 HcmV?d00001 diff --git a/.github/assets/logo-light.png b/.github/assets/logo-light.png new file mode 100644 index 0000000000000000000000000000000000000000..a93bcfd17079c340be4ae8ab0a193afb39a6a1b6 GIT binary patch literal 6941 zcmXw82Urv7(B%p|*Gy&<=0|7xrQ7O`;DkPyp5&}e&qCh~YO1)D+={59( z1EorlPJo1dl+Xe}NPsWg|Gs^mWZ!ppc4p_DnVolj6Z7za5jV$04i**`?z_eY<}56% zR?KnmX%O>Y?rCf*^K{1B*xHYUML_c82e@l~Ws`Xk;Ad|12TMt>=rVJ1%Ki5J+bk^Q zSWbo$8w<ITd9n=0qOy3TicMv4 z7Q96VZ_)9$=X=$?PzwRPKRteO?Gl~tB9GHTe^m8xUG_C)tv%A4hpBrVe^AMG{`eh9 z%E>~VuHvFhy(JRC(ZN#^jp2$k-28Vsy<91BBf z-v>@qXGhO-l6#?vpJpBfiLd1nR_f;aBb|<+yOZUTmx%&|%+bpYd)I~nLhdpZ#2eE;|CCfnc$@tsIHLacQ-*D~8Ci$q-Ifm*n~vCc zWHFiTka2{5<4acs&BAm0DACa!KZ27Q?B){khl>emVQR_l^CVEn%hKG3XwiwAn*oKg zAnPwW{Zsk|H8&h>&{$(7NH+)v=w@ZZ)?kKvI<)?NgXHC0UFeU*l-ii`&|jGH&7AVW zZSZ~Vk_dZ9=iBFkPTOU@h5@i~xgDSq`(T&zJ>`Z^ZumG}B=hOftp%%Zj(pU@A1sY^luWfRju>My4p8gmz z7(p=&NV5QCph(9sboof6YH55S+T%+kM84yQ~u!vxq;_b6jR*-$*G+zKv zI%2KmbUZVNT<*xi_!fKZzXv3w6rIa{g(io-E}F5t$2kb=WXN{c*#{o%wO)_Q58K#E zZ|vLpigqg|{=G@(tt5^g!`t!?cX;Ud;^WD3p}5*&XtL{?%+IA|uQv3a&G%uRGSO|f z^Rux}qYmsp;KeR^j&1VOaJ{qIP<|z6dDP!Rrot$uzJl z=GrK*3mwY{U!_l;-xpSk@1Rex8N-NbNso}Ep0Dk+=F?|!yWCx24ZDIes91@oES9B9 zjhCp)yz9ric$vFUr`!J;hh4 z8DkJnww)q?t+sZGLY1bxR!ZkMc1_0oI#6KU$jpuGotcOTHE4*JS+}hjn7+D5>HJq9 z-B}vxy?eyg9TIf_oM?Y643|q1i`L>2HJU$MOxH>QW$_>u9p{|qZaHQO7hAMDy@PVQ zXqzks=%GqmaHx{%-gjet7q<_MQw007j4+2CZnNHCRQRsPHTUq%7z9euff+Om6*!w_ z$4&=Ty^Hkf?pxpmPqNzO4eyx^-ZoOI*5cgo>cgBh$>nerL5wFjN*Sk|uz;WU zQ!L%{INmRU*n-3KAW^%0@7U*kT+}_++8qeP0}fqnAJWxq1v|7zIdSaXyB|MDE^ho! zEn*{^m;1%XD_(Qzt@YsHR%<)t?8d)J&3(Yj26PW$sCK!&rk?=;5k<16-YeHAC%8Ja z>ZqLUkH^40fpF8MJK1&I+SU&W)h;2~N?^dOs@p#U%EpYT(Fe0Ee1z2;)zhQ11QdJx zC47XGWDayGaaP{_cn>)8)j?*@$ScaJ{#)^umT`|CWo|RW>095kzUIc)+E<%zYXUNO z7{AZ8SIA}x@*vvR_vSb7hMHbsL2XL(frxiQq9v;xTAmLM)$c{XVE!=UrOw6^#~?Pb zfqx?%P;^R$lco}ALutkNWc_gN&?ml{;9pw&a=4x58^Xbjf6$kT$L4%v^itCQyhio+ zaAvWTr>SWq?BnhMe>=O1cY7D~5wfwgTOTa4yY6lQ7S!)ubGlbY%3sYHFRT{YF421I zUdBcIs1PkEymkLst4fcORb5|{%vN{+wK`khRS}GRTi~UafU#nfglYB@|%hIvM|J z)m+09l9{f0njXu*rJUGDJ3Q=cb(=z8vv{T3N_ni)IM+)V-RUmxV1%BxRdf8vd#3wY ze;u=qoZ!7%Nm)%?$Mm3n^3!LAYTQ!2JhsZ{EHKoRY5M;A^h|%3EJ?K_@GW3)mP~6d zHxPg5*#&laoNXH1(Q~{U1L>yLivH8~fRNkEn&_wKEt6sbY^OEdehESF#=U@8fbHz`Xd>ruynZ5_bpb zC`0-swh`(t)f%DO=bPQm;iCT4*G>23G6DLRS&ypw)DP;A1RlR4kVH?EN=4f=8fk;A z1;b?ZvDQS}S;|Syghwg26&6mCZ|u?>Q`3+AI3p^!7A$O4ylr!R zm#A%jWk}*c&gA-?8qB3I!&R1Py%dEUhTp@KN7xK`*r^IG5NcrdAv-ZXB@Mp5Eme-+ zw(3m~BY(%6YRjV(;ZfUM44U1-qtI3jMYBl#CL1|mO2G3hnLegvNCL9LDePdKT+!6@ zz3}Y_8@;2N-cEuKTUYE?13l_c!XxaSR2a{j9^_5ROee#cD74a%t`JB*r5F||L0x~8 zb#2w#xM#E@#1kTasZ#EeLYUFwr}O_f%ynv9nF8&)Bcz%P8env+02ABD6rlaXe5&4d#Rpd$gpUk}+QR%TzL>yDnKI0VYmW z8QP63;%xvu7N@%JTH&-klSzsDy@yYWqX_zj=(Kmdd0bK^Op5^i_gN}%M1l`z z*FiLr_spJfz*fPvz{xcQjVmXgYv6=qO)7YjwHE58UNo9#m@;MA6{G{=4hSHxUN}c} z10II^idxeyDLb3Ft)1Iu2AjN(2lWQJlL*d|A?9-H9|qb=f3d&6)MFA{H6Q^ea*L)~ zKe(ryH!sm$&<)sC-`uTu9fG=y2T;_8G*wyCgW@qA`1v&>b{Nro)Q7{RSwVd$mD-P9 z>1Ok6uIk4S^XA9>{$Ey~dexbt>0Ab2xl==}%Bg^q<@p(~3|`P%MC)nRl{$&2$yH`# zRG1?wAix!eFMUYwfCk#RQ}miAt9R_vTPRRu&3)D)y_A`9QIWG;#;W1OEZ~F>na-P< z7F3Y5VHzt_$=>o80~FwrrPn}ssn?W##%$#Kzgj^vL7#c6)B&-%#XP&K|0s4vFNY(M z6>vp}zo&^C16e>44=BD{N+Lhw$y)4#pY=%vr0Oq! z)W1RulL=7x3iQ3+;wR~Z1vQygEu4xtx+arS%Hx48p3|G3N<_#vO=;%*9mo(S&OGdk zUM`#h&kMw2m!-W)(f(w{Yg&B%e3`7#5FK)jETl7>0c=_lZZ8{Mj z_J(mM-SZy;+V5ts6eO`7qZx`dK316@B^M1i1TeQf%C+T#@W&H5z&-GU&>Gu30_I9z z3gLZkv|oUipcW;9s*Z2w8SU4|w3HnkNhKoZe>#@IUki`$J;Y_j_vl{5BF75J=Qx{6 zV#Y^?qH;||671WDh&q7D8u@|q3o?kYCLr#9q`!@I=F!Ex;&JDXQ`oxcS45EM&);UX z_vf4sXbOkiAFJyxY<*jDAiI~i^&~H9R%J@62er{eA7L?-U&hY~XxdoLYR0H{CdBVU zrF*#axk|KxL9oa#`p9fwil4bzG2#J(T~s2pd)c&_c`urKI+be}PT$(D3;yMz@dA~ygdr`arUE^YpQd?$v7ecvYB z7@dgto$@Mr!m{0v5!ly~Ts4f*v`@o~gS6%fDx9aP`G$?nxl&j>O##!< z_5N}j#FRaUA`z;Lg$a3{kPDY~a#%V=v^*3G-cm1>*rF$;3b6i)>&SRBi46ZjFfnn& zeo`jIK6eWzwOA2LoNq+v6l}qQ+{B%LYLQVrt65V``>Pc#++yvF7fQ6h$ZzD0{uGgP zHsVR%6v_5CiEEP3)3_hlY0OXwxMN&%BcC$^k$T!=M{L(lbqIB2W zx82)7aj9)8>gVvf4!YeEXx(_J-$nWCs>7=Jt(?pyuty2- zt_S}yUzK~3q+z%`pzar_#~grhv>$y)y4>^i@jb|{@NZ<@>yY&J)5xl&n4}xwp6wS! zt)mdEGqPK%>`8-s3(UM+co)mVsC)Dc#)E)vb8ZFQiFj(p&$x9M+npI=v{-2w$spgT z)|Y!~Rs+NRz`!FQyG^VPrRvPmu7{M%O&k9%&;n;Kd7%Hid5x-EIuNgqYzn=!%}uVU zOUWwGXCc8acKNuB7atUE5Jp$SE0BM#u{2|q`R6Vj2Y&%DVb5 zbO3v#WicN38?bBTmg%d>YP7h~Z^(kD_=J}Rd_U6oODC$W5uCme9;kG_=cx`=>mCd4 zXSLd&Jmv7?^xtUgHu6t~x^_<1%@Yrm*b%i!pzf2AtweyI3i494K$XX5q(7 zT7*%G0NXqzpFPRlO2Br(-}XeGxM2H*jK|8aiY(Iue2hmwAdX`X#?sH|*Xu3X4eE_Z zDi5c<@J|mw=ppKsz5^B(Xo6p`t5+bd(rPYVjFDuXqD3YI!~{!Z-_m{brkj!Lfx$dc zitWrjY6o*Gf2Lyt&gH5$Pf3M{rat-s*bRxOCyI11JULwK%&{%c4tg}e57!%`TY_L= zt_2bPoaX3vEp*IG=I-4voQSqP*~S8Zw1* zg9ie;zi*j zP{Q8q8?I2bCF!+FkOj;)TjeAjOC@jd&3Y7Y{)X?VJ)6XOSByRAl|G z-lsWw-7WIq-RbjT?qszJd!AKAFZs>W1^I21zkhvg`{am`sZ3VwfTsdh6};p-ULtHZ zzlJlA`0s{76Q`a5yYO;|(i5fN-AyrI1IpZ7-P}~~e^^EZjE7kEh9ChEf$Xxeh^f9e z;r@t`!6i$U9-xY(N19p>+B?F1d4DWDs}KXL{3y%TTb%|LrejEXC>IZu>u;VguJ>t< ze-nIM4n=EPotp}25GY(iXe2W?y4|(&wo<|Zj-P<*3#V*aZCJ&ihb?|IX1pttrL^nb z^iu6NcicsRLW%3vdWR3B8y^O~gn;6KmPS#~m?dkysl$q@jq9C%QOLsd%8NK8t2H)7 zhn@7G&eU`0xrb&q(HVu-?+rSq9Y`q4)HB5lyE2z+BhyKvWX{KOdu(~j*Kt0k(Y|Zx z9D7L#578wJl=O?f7$P=o&xxIRq}uhL<_T{Z?kl?=sevBZ_n9rb4}#f%o>(9i zRP{fxnHt^WT>XBBrjwC;D4ACs2YZ3(H|Js$7C78?gADpm65K=X>0YAL`WT0e&t;S2 zTZ5C^ZPCY^gOopIQD~DbhU&aXi~QvH$5wxtBXBo-=KJA+L)ExFFU;0sYESKRwqN;A z)|%2Ggio8lz5f_3ZK);B2Yf^Rtc?cYqwt7>aC21?$im!$YkH2bc$3?A3s32U&u%fJ zNn4BOxzUirfYnuM*FMkSTS_X;?A9!n?g3w_o*C>SQp?ry^9@6uHEAB9ULTaBwpV1D z{O#NPE0IVQU{YA6nfNeqw&gpk_WTX~XF1GGnt{Q*3OAXxXf(kkvituj76@#Xz$@>ZIR5uS zlg&6Xs|@c+iwBW{$!_}f{vPwKF3bNz!2fggWYl+aQ~HdM#m+S*!X51;Lci*`mu7e} z?x>ulKIvIYW+KVa(OTURVYPNA?H_wWuRY>__eF1^P8vVvPk7}B9AnYCOeEUC<&)t( k_^G_-q0%SJQQODIth7sh@9Id*ZWhbkI}Z#>{&0Ntf3gVDcK`qY literal 0 HcmV?d00001 diff --git a/.gitignore b/.gitignore index d2b624fa..9e2519a4 100644 --- a/.gitignore +++ b/.gitignore @@ -70,7 +70,9 @@ typings/ .yarn-integrity # dotenv environment variables file +.env .env.* +!.env.example # parcel-bundler cache (https://parceljs.org/) .cache diff --git a/README.md b/README.md index ff71a672..76dbb4a5 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,18 @@ -# Parcelvoy -Engage your customers through effortless communication. +
+ + +

Open Source Multi-Channel Marketing

+ +

Engage your customers through effortless communication.

+ +
## Features - 💬 **Cross Channel Messaging** Send data-driven emails, push notifications and text messages. @@ -14,21 +27,22 @@ Engage your customers through effortless communication. You can run Parcelvoy locally or in the cloud easily using Docker. -To get up and running quickly to try things out, copy our latest `docker-compose.yaml` and `.env` file onto your machine and go! +To get up and running quickly to try things out, copy our latest `docker-compose.yml` and `.env` file onto your machine and go! ``` mkdir parcelvoy && cd parcelvoy -wget https://raw.githubusercontent.com/parcelvoy/parcelvoy/master/{.env,docker-compose.yaml} +wget https://raw.githubusercontent.com/parcelvoy/parcelvoy/master/{.env.example,docker-compose.yml} +mv .env.example .env docker compose up -d # run the Docker container ``` -Login to the web app at http://localhost:3000 by entering the default credentials found in your .env file. +Login to the web app at http://localhost:3000 by entering the default credentials found in the copied `.env` file. ``` AUTH_BASIC_USERNAME=parcelvoy AUTH_BASIC_PASSWORD=password ``` -We would recommend changing these default credentials as well as your `APP_SECRET` before ever using Parcelvoy in production. +**Note:** We would recommend changing these default credentials as well as your `APP_SECRET` before ever using Parcelvoy in production. For full documentation on the platform and more information on deployment, check out our docs.