From 1f13408f7fbfa551790ae69f28427dc0dc3a3021 Mon Sep 17 00:00:00 2001
From: "R. Miles McCain"
Date: Fri, 24 Apr 2020 14:42:56 -0400
Subject: [PATCH] Improve README style
---
GUIDE.md | 9 +--------
README.md | 18 ++++++------------
images/logo.png | Bin 0 -> 12130 bytes
3 files changed, 7 insertions(+), 20 deletions(-)
create mode 100644 images/logo.png
diff --git a/GUIDE.md b/GUIDE.md
index 1289031..8763768 100644
--- a/GUIDE.md
+++ b/GUIDE.md
@@ -1,11 +1,4 @@
-
-
๐ญ Shynet ๐ญ
-
-
- Web analytics that's self hosted, cookie free, privacy friendly, and useful(?)
-
-
-
+# Getting Started
## Table of Contents
diff --git a/README.md b/README.md
index 5b5904e..ebafc34 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,8 @@
-
-
๐ญ Shynet ๐ญ
+
-
- Web analytics that's self hosted, cookie free, privacy friendly, and useful(?)
-
-
- Getting started ยป
-
-
-
+Modern, privacy-friendly, and cookie-free web analytics.
+
+
## Motivation
@@ -85,7 +79,7 @@ Shynet is pretty simple, but there are a few key terms you need to know in order
## Installation
-You can find installation instructions in our [Getting Started Guide](GUIDE.md#installation)!
+You can find installation instructions in our [Getting Started Guide](GUIDE.md#installation).
## FAQ
@@ -118,4 +112,4 @@ Shynet is made available under the [Apache License, version 2.0](LICENSE).
---
-a17t was created by [Miles McCain](https://miles.land) at the [Recurse Center](https://recurse.com) using [a17t](https://a17t.miles.land).
+Shynet was created by [Miles McCain](https://miles.land) ([@MilesMcCain](https://twitter.com/MilesMcCain)) at the [Recurse Center](https://recurse.com) using [a17t](https://a17t.miles.land).
diff --git a/images/logo.png b/images/logo.png
new file mode 100644
index 0000000000000000000000000000000000000000..322f403b5ec1999090a005fca1fca6e900579ea4
GIT binary patch
literal 12130
zcmb`tbx>Ac^e_C7(%mT{E#2Lc0s=~RcXuNxDJb2Iv~+hUAl=<1-F-LT-<@~fxij~_
z%P{aT=bU{w>#V)j`b4;rf)pwe5fTIfL6wn~P=-LD{lVu11bFaMVTm^q{DO57lTk$g
zU)~7DVc>5l#h?%XOjR~WZk)w%;t&_Q(^D#`j5CrlXA|oNH>YjGE
z6x?V9&`k$vd$(fdw(Bh6`T5oIQAi|^N;KYwH~
z#1JTgFuoYPb%6xEe3odYg?jt)iIwF$1ncD>0f8(85u782f0T3mWSG-Xt{f5Ts`0yQgxUtzeEcu8VCbB~
zfeK2n^2{10CMNllqN@Ednag7Dn`CRANYjQ{O+47g?#v7ZR`_3TeKQe3wOR?2
zoI@=FiTzeCHX9)Su^*!=w%zSzi7;_ytd5dXI88zt##(8H4fFs10g)=RjtrUhE;~O`
z=Kp<92@=n5|MS!szW?_J_n7J~{FLjymFiLE#sY+;){UGmXV!J9$L0&hkz
zi=M7CILJ6Hf-fd0FQUPRpY-}jSVB@V`2C~0I_>CWBWnt`-B+fJ^tGue(&1E2Tsq6)
z?+FPM+umubS4*u;BGmB?kzp8OmP~xGVqwvLyy9ZI+n>WJ{Ya#|#js>$WhDvwJKKaj
zuXaN)?O?MaLQ{=pCO3xOHF#d&Eebt)Ld(nVvNKWyslEa!w3`$*K>Kgr3!`5lP0Yd~
z`E$SR`XYi|G=juv(OQvKee~!4f|qov2?c59EU}qP>)q%{iiO22ON#XF9ZnLP1xbNC
z(JMJQh%d^Qwx#=y_FSP~s(JaYDn;X6k;6{^YWrA<%gVs-iksE>wj;nMyha`k$wCVPa7qSMdA`{WwfmukO%(;<-XD%jtzpdAIJ
zT1iD?hRe}hLAFg2KAsiks>*WKG0KVS7PuO+)f>o$TQZp^y_c&;==3l|SsM
znZqlEF@N@nh)Aqa`P)A`OMn!tZ8g&1Y^m$=mqbbv
zXd(yCVjs@Tx`(yS^wx1N0#t#Uw;v#%BvtPuSCpXDeT41SR2b~6N2N&wTZoxR7o7Hv
zlex;Y46pxYp3DWtH2fo6#Qc>gt_tc=jp&*9>!3-A;9yA}-*x6~UsL(iFx)}BFwg$O
zO+=%UiI7^qV{)ARYvJe(8KHC>njj3H*M}%szr_BmA!2^$Nv185omFT+-6u9P-Fi
zk@$3ez87(uIb^z@o0o_4ajYus%^Q#>)blXX9C5CV()$<}VqnJ?TpblIjpg#vpk=-t5Nk)%x9WmQ72`0j;`@6K9;fp|YwRwI3dhg)PTsVzan~=62xk-}k=06i7%&
zA3y8D%ONAHYiM-#ZSS2MA~-raeoOulwYVryBrB_=sR_@nqC$(~sIIP_B?{v;JFhNB
zO6>t9gWVzJMw>j!eUZ|t>FSC$@g(fzR9S_AunOo?`<$1SL==Xdv61zsO#~^OTjSpIfYT2pl
zF@MnFA`MYLU1BPw`w(r^ymqrMwp2{;8@gL8rhM(rFQJ5=d|UJL;pXdX!>=l8CEMEs
zLFb6S&H6Dpe!SS-SacrN92@q1vZTS|fb098b+x+cN~Nq~CnM*7vt;Sox-a>k!evn!
z9QMq>C4}j4`YG`zAGuqAMId#U)rO
zqdRV--Eg1stb%gtY5r2!x^Gy^f+)to%1EaSR_T*+;35CD{_#^c(TFWR9v%gFkgC)0
z*xvGP
zKSKNy7*je6{m4%U+tE$S-h}jpll(sUo#d<>iQ7Uxg&do4=zqq1Y93+E>uy1lX-^eRnI(pKQ^NNfo
zvSQjhCX_Iy;UYOx&mRQP@TKsv&A!U?=D?03;&a&3LaA~zjrgnF^?C3caJ=t54`d&29ZaSr)v+
z&m~I)qevJ-X0#tU7v|G@h8|J0tByh_M5MBU*cVDZ`w7lUC!
zl3l*i5ZpWXdCmETuq?`hYhU2+`}EKfxmWK}xL+Nm>(p}9QN&x5GCzI=>4unFqe>5_
zg4>v8qc_`nkFKQsuf2I*=A6-
zL_t@$C-;3X+`gvy;pvHv;`B{OG(m)h6JAzPm?LbJOdRCr*U1{#(*E%Z+C8FndUegp
zLqC<0DTEk-embIV7YbHFyO`9#cYT7%DY7!HU;WpNViSB5i!(d?Mdc3_gECAlD^A^M
z=4{*c=5mSmr^~wOh=zOns8-9WRAQ5hmv**h!&L}K1yJGOf;CC6Gs#Q^x>7~sD<1|c
zKI-Z+X^@Qkn|o%syG4}}TbC>rFCKd<11V0be9E0U*&^bZWyiN)zBxxz7$YbsnX%Qs
zXt0>#%cc$CcROB-`nZuCH)0?@ht)BvvQ|`DYP>Iw-7nsqG+*u8{w|KWK>y;#B5t@v
zO0wT@C}@wCVZ!$emlQkHx2@Y=q2Knj(dn8jBnGLE+%Mxh-*+OpIM~>$=RILhRK35G
zHFzYXbC&+SX)*l?HtqIb2P(gRPcXdmBA4-HJ_Qp;62~D-XZvI-x7Am)!v#dLX9rU}
ztav6w+lp|l`U!{gZJW+RTqIuaSJF<9tjbCR6;to9E-?$?$-X`+{U@`*T0T?v9$r{D
zMe$|qC2wJ7I=bHPgw<6ZR$-IblhSc-{na**^9T~`B`OT2)a8mH9Xa_7wZHI-3p8%0
z__P~6b@o{x0+0Dmy+7?>>&?<}C#Km>PUEdNZf-A(miZYbA4U>3{w{gNMLxEqxBu%7
z5O23KDaEEyq;x;?%TnIEaxDd5?Vb7q94O9jU1&L@r?ER29N<)+E8vyrrW&xMWL5{A
zPj`nFr6eWc`l2(VA79m;BWF{;6ky-Qnh*OdPyLFiZmT~#QVpOV9+T>@)AY3y%ARfgaaXGuxuYE^}H
zYjpGV5wfiwX=9^DMTPi%_SWFR1~;F}A-pcZ
zLPkP5&Ab+#{%v@ECtVVpg-v-@!%KphEL+_7ni
zpMAgBwJn6L1w0`Tai;CXihMX9D~#a0^OTZ$1;zt$ibTp|86ii<^VrnX{_jJoCWBWx
zyX(cb)Bd7ukEeTqCbV>PxEx2}qZ3IyLefeLmX{+9&x&8SR=}W&$8;-}%cY=zs&8e3
z+PFx<>!BDMpZ;Z0z=4|M&){Iyd7@9!
zSzX=plb{lqdKWC*Fg&=3q@H;GZsj>F21`6NSnwAp5>|ZVuP7(0c*t@PI)d(^3`$(x
zUsxbc*XC@-`&IYj$Lgv2Z~EE>-Lv8QnQw{t3tnh=!7X?A`|DY%t;BNgxGpW%9_=(`
zNkbHVmX-z`uYPOz?kQQrO2lm$ChGe*T3FA`=jIqtY{59zhqds(5oFmjJlYk)$#u8C
zZ|i8bPc!~s1sr_*4Q=OlU6dnh9i1zU8PObETz$9IG^_f0dK-1e@|jc(Bq8D9h)lX+
z7+d%sWGv|Bn_cm>Z3{il3&Id^+g^<{SF~p}`I>gaCiJH^%gLwNGfdDeZlQIR+b%ylM)CFectw%HLimVPe1TH+g+S4p*^E*aLYinvjE69D?_db*2NKE_`
zQlt8F_UR2{->kG)=*U9dcz(q?9n1IJ8!>S6q
z&{{o4an&BycQ?*l0)mUWO&nB-gJbpe+zIa<2*$qkvz{-}Etad46cu53YbI=Q*n4>J
zDujkRRd**>kIC2KxvcHi@64&s^qu9OWBP1^u9&H^b#AEB%mt55;y-ko#Bupoj-$AmJ}AFAc**5hJ!AC)I_7D`0f5orQts8Yl)
zdaUyF!oHikM9p4iKI4-6ctd08QCqe#GEUhb)GwnkHYqZ16Q}d=OMhe+KXyM`?+F{=
zkUB$LN?_|($bKc>uJp%-XF!zq@ViB*41N|U4OAJOdtMwKGP=CwN*^pwtb^_CUmaC4y;_9r(4epl~J2+n7
zGv-d45AyP>!ULg3998S~#|-X^@!4I8
zR(e5OpF@ONo4Tj_QuJ6*Ok0INjQ;+&@9uW@c3UV&h#3<5<3|*wR1C7^{XY!i3YCFR
z$=9c^0@1Zd1@Zpy5_MBpLKo31Q-;Jrf5CKmmud>7*EukNa4wu2MXELJ#B9(p7?oOI
z;C2vGG3^`E)%B)W{3qA--|}7hb>-$SK0YXf?*tHG{5e7h(?vo|R>3Id&`f!I
z)Os)PQ}xd5+!*Zrz7|2{nkO&ko|Y@1RXw->@J{}Gm*l^l!Z6B
z9O(BDLj}%fprCROz}O0er9i0PZ;rLL!%O6=s#G0Y?oX7w>JsgZJ7iTE);z+(p-)32O8~OfbT~N2J8Yss4@;z<~uKuFLkx@~#j`Q>{0QW
z&UZ;j@o%|;`nCAPI#4fMKmWD#?s|{zj-YfTVw5jpYio1WnmF@vSGg)m{kV5i3B>i^~(IlmU9YxHG*fcDrQd?G)@ZE=~X(mIbw
ziCJA7S>|g^_&*H{{#IE_60k}5o7Pcn*m5e4%{4uqz;a5?BVz9n4H|wR_Vuq{js*<8
zA*fU7>m#2Nx{h6`I`-!CQF8m@$@
zs;cQePfRT>;)}DRkkR%x9JVF&bfOZ*IPeHO=|s4s4DNaw2cH?8x4V(EmUeo3B<@F$
z2Ll*Kj>d8Jm<$@e?LK`8jiV~R`|1Tv@K|{C_u(CqMWM>$36Yh9(oeiMW7>uiWS*$_
zzH{6jjeIWFtj3kcE1Y{rOMd?BW=1cAoms9SKzps3-Angqof8wNl%dEa8@&bP8aQ2*QO+%)eGO4w
zGdokH&nHq_H|O`q(X6)&_>JACzcY<0EhF%SQMjyofEyb2xXJ@J{}+K=Vg+8l-I?L`
z_V&s79!-(W=g)P0*Ft)rdA&ksgN>T0jo>FC4Nm+^kuo-8MWRvp-#xHJ?o1Rjq&T7S
z&1_9WpdLL94u6_Re?{&GV@2@Ml0ak3d4DDiCUIg%tKONTykxdwh{e?<%9c^c!N8PV
zNKU1+U%B08euKIjJ=QL=En?PB=?|g81MS*T%vtvVE@6PiczAWIuQ))R#^;J59*VL#
z{~VKA=WrOKS{AB?KUqRkN}XM>r5}{w#|nrMQJ8yVOSvG{Awm&Z2xl)NR9-UK8JpVr
zc|KY|iwJ-ur;prv>(}BGL-^CeP7j+F0`9cd$+6~t0r7nNMI@!k_0hCeF-F)uDFCq7
za8VN#ii(rdhT&w;v=PDNkTEsYS4vKcSRFNkA>3Q?KSS%_ck2|GDmDhPF$&hZMvA5^
zNrWjL@@U5vSwc$Ie)1y^)I5|J75bqDBo`M?QeX&nP(kHw=_%uC!cY5vNWbvVkwlmS
zi!*yC)g*7;Ol|FtLw!giMzr+GNf~Ss8*HCdpLw6DyBs)=wN|6C5xdLGg!r2A^qX3?
znZ)&PV>a*8TQO(zk`3VS%tLrwDE(DvnmQ!q2T;>!
ziLfl`SI^(nvKXQ7awE*lYAokSX3AG^7W)A;_#I;T@!a&oiD&3ctT(IVMjee<_fL69
zaK@9(>?kJLQ95ibm9_f54-p}u!PU?nNiIdxR}VxU#!oW6nZFr;pkkai!Rq5P7IivN
zL$NIJnlqadsw8ENftk5~uTom{5gv^&@ALy@Pz+Eg^o`&Cn`zc83;DXHpqnF{WCqzw
zQ|~T9UIe(B)T{)dtCEVDW)mnHT~Pk6TF{(^lh;K
z1{;$UJA!Pf`RU-fw?|iG8Qb9AZSSJOS^k4n_DAu4%fwrc<;Q#Uu@(*NHc`y6zWx#!Yw7r7D>^(MY!$P6KH1;?{a_GQd9XGmX}{2L1B-(<
z{STK|4Dt2Yuat)&AO=anyz=TiWM{8-I61)t!E*u(UU*cHEChnK`{D%vLnZs=+H6OF
z3WtP>SfXC0A|!bEi8ZbJM_`c7Qj-fTz6&$J1Oa;ae#~#yb6{i5KYj2sUF2_Ot9`y(
zAkS8n_4;<-bnItnsaJ1H%EQaKii0|)dYmB$JKRA{Rk#XtLr4dJ+Ha|K#v9O`*x3Om
zHPt|hDRrEo8@OOQcZE#Pz`*JQ30J>JQ`B}F#39ExfgVRkIA5-e(c1zkx
z^DBVmmP_#K1%x80kfZ#`_zHVD>B2c;2!f%dCh`|}G>pls&FA*3saDDx4=B>R!q9)V}D_meI8jYFN}v$sv&x1k7Vutg#0VR
zsvA5H;X&%w;w4h6_Ky3y&)}#KCZ!0airr4YQXwVA4AObaHe4?e3T{9*DGih9jZIz4%t$wXKi~P^KicIZU!oI
z|L!587Vy`^)3v=T6V1<~$9{=rbWBVyQb2avHe~PY><^SxrkR;4JSM-J
zT~;TQ`M2)ymDHKrZ`XhR9#H_5At^BcYPC9_;dCkF1Ie488A<1-2t?e$gJ;zM`JrKA
z;$@K8+B;8rlW!+GjlH06_MIF~TPrK8FS^T19JW$DoCeylt92S0bM9{2G(`CLGpaza
zDt+>7eQ$$=9Pxrkfu?N2q;(lt44Cr!h(so*aB(f*WYAQb$V{)7Lfsi3`TAo;|EvZb
zz>eYkcKl*c`a+_#SlP_69M5N0B$oJ_b2L=U(7s{fu_enZ(Iv#iDFYS%y^Kt8pA8KB
zeOFJ=;N@9RE|}2d3(pkOqdV3|)Epvr{eA$k;m?JJ`^jr@dvch&%WW*=gR5X88inkf
zoItsE^RESe*!_;s2zR%e2!NC1X8HVy4TYA
zXd0b-MDObW`^P}+I>3BY+CD1o&Iv;{Ry-6>mb36394-AtnxMqYYHTKCt<;dYfW?A)
z{=T@{R6cz`H3tdeJLdxlpzQn9$gGGBtQ8%jm`0V)tH<(>@(8}E3q#d9txc7cN-US)
zZbbi<86FheZE|is#Uxl*-8sOu{tKy8C(a{-(Xp+wAZr~PNh;jTLuVH1zf?O>ayUB%
zx!5oaY;Ch}afw#_BmjZ|8yndM0B{YikJRhTZ`V4-*9PBJumNBmXq)|d9T9~f440uD
z(D$azR|SI7b^jwA8EtD2gcZ0s;n%r+U}pZ^RI
zqmUZaqD;EGp-GkxsVmc>I0`)BUz)PyG#$|iv*Ew)0N}&f)hPfx5DPoII4~PHIyyO=
zeJf&cIfK?@qYx7giV?OQ9mmoF*SS}8vg#xW}=V$U|Gk6PmZu1VrLzx*XYt9wlBwKAu4bMI-_QejzEq=Db)RJb85BzY
zP%oOanAX?x1VAO9=p+}c^4!9@xo!Ww)u9HeR9Dx?n|BZI{0lE>i1~QC#>Za-OB|pC
zax1JQ1A%R=|I$j|+IpzIrr(50n1wJ5cgrxD~jLS!g*SnJoU!}>RSDkwW^$#Bo9KH-#XwB1EH-
z*qg7oIy?I4fF;#i?3uQQ?qVhlVlA-_Vnb#J2PFhDeL1iJ3&Q9^K$I+GB7o;j?>kgb
zP+PelF(M(H<#0KV`Y~akBm!87YI>&oh`hwP3?>mAgj>JthPfcVjB$fo>aC85b+&hCK+?!ZlcIdQbKkfK*IS#&^xZok2EsmQsax}fnTo;#
zTaGWc@H&smzIoIS`)m8LSfwAYx$c=(X1K+zP_Zu$aou8x>
zXX%5F!m;@x#QZmk*l=kcclPT1y0WBDPln;P!T`!!@nC#!B_(&`pki(ITkDHM%9t&A
za_xbUMIS?fls^oNcd~fh>u^qzO9$_^L@|J)?_1alS@KTH-^swwFcOVA5XAgsYX|v-
z;ceQ>hTlEf`fW2k_qUu0SXh9IWEUPx2Jh0YDWXa4B+te_fgQ22no)LhbifP<&y2h(
zh++xpzsD`JkAJ$QJurem;NNcV?)oz)Fp2=W+MCatI@s$kl#q#NqIw@
zKJI*TW`zU2A}0zoRTw~#og6LWLVfZ1SQuSqZiH!picAohSs%o5Ek4-JsRuyn?*1Gh
zIy>3g=vpq1=fAf=G0gt;EAD_NU0W{{^lTI|9uX_Jq~KqbN~=qI@vH{g7|{m{iN+nZ)|FNvgf=#k@|CmZ}ZY-J5WVc8ocJYF1;`v}dj#_=J{_#EG4KFVounvG~
z4i5x?m}a-*4TC<)sO88^ovFzN2XPMD-5}RP&F+aMR7Ne1iDDmN3GF2>^e#~U0vEXL
zmT@q%+kroCH)64c=A|G8_ZYwUM8M#<*7+sUvK2i!WjZk42!_LU5rdS!1-@Q^$^KyS
z+ktfo&eyNs8vuWcjQHE{*-PNhkeG!G9dNw8W{(r4NbCk%1?}o`ZLtA!zSbuAuPsv?
zO$!H%bXYVyJ7=($nOcLJ>tkj+Gb3YnZhy>2b#+)12UgGsXqi4|x3rLKZ<_)MOPncD
z9PF(>f3N`APCG`qd*kT^{C%d+D2X5gAH46LM#9fPWivK0qokq1zl95?WndKdkmMa2
z8hV|WDsIapmCnb-dG*-eB^E%Yt25eN5;2)=9tjfc;(M`08Ie~n31+Blepm4Xro0a<
zJjx~xYB3@}FP&8ZUpA{XB%GWPfDs6#C$nEMJ1YyQ@^0MtW!m2)5irSL46TN*fyrTL
z(pNo8xDa?(m0z~B7)nRk!d{pFHe-WNnI`oK`DQok8?mtO|9L`TUhIJKR05vY``Ont
zT!<9Uk}odAN&CbK?e68r$ia4~FFcas2xD-8*dq6RrUDxn>219wh(7nr7mT`M7aBl~
z5=yFu;Ns#2-dEPvcKScH^1hcu_?EH?JK8yyW=4`TQSZ)~ZMTxz)+-m*_7jX~Lv!c$
zr&wB5H{ZHp^i3`Q(9w&9F=3=Zn%oa&Tt436RZw3XdV#AD$2hN#g}t|C78RPma7!un
z*-1sSMwu8J2eFD$Cf~gd+9m4@&PuIO>1d3C{;!5(20IbMrPQcM1E929`?|;eWw-eF
zgm#XNK^@sL0UrZ`LNuzN=%zr%XvZDCicINQZ|Tk(PjLgEX%AP_K%t)9Tt&9$n538rhvtuTxa
zojI{)nPWS{6ji&K=OSPQq0l!ll{8+f5fSsopU5i%XRSWBaynuVwM>`uY9|Q
z(09UxqUEW(%SnmHK;rEhVT$E-*1S6L_%J^P@24YL0Y|~9xU09ONocm+tU`NBnHMrK
zjA{fD?nw&xb%8(`F7&rD`wOerw)0p&MUeDMM?x5b8Qa-VQc|MbCji2u;o;Bx*x$xE
z(c%c-$X-%1=T(pHQ#uAoP$pMtKse$|x@Zsvsig4U%Mmff@Oa4li+*Q6HJ+F!WSX+}z||e*|jOOdB{S=6}us;!5KsFjj{{{DfQB9f0G-
zs;f*-EX;RJ^A$+^FrM-8-0Sw|b%5KR=1%;Nayns0WXaD<`F-h-Js-*8QL&;