From e7d9c50305ef99486c15da01d40abeb5c782d5d6 Mon Sep 17 00:00:00 2001 From: daffl Date: Mon, 10 Apr 2023 16:47:02 -0700 Subject: [PATCH] fix: Make sure all Readme files are up to date --- docs/public/img/feathers-logo-wide.png | Bin 0 -> 18567 bytes packages/adapter-commons/README.md | 10 ++++++++-- packages/authentication-client/README.md | 2 +- packages/authentication-local/README.md | 2 +- packages/authentication-oauth/README.md | 2 +- packages/authentication/README.md | 2 +- packages/cli/README.md | 2 +- packages/commons/README.md | 10 ++++++++-- packages/configuration/README.md | 2 +- packages/create-feathers/README.md | 23 +++++++++++++++++++++++ packages/errors/README.md | 2 +- packages/express/README.md | 2 +- packages/feathers/README.md | 6 ++---- packages/generators/README.md | 2 +- packages/knex/README.md | 3 ++- packages/koa/README.md | 2 +- packages/memory/README.md | 8 ++++---- packages/mongodb/README.md | 3 ++- packages/rest-client/README.md | 4 ++-- packages/schema/README.md | 2 +- packages/socketio-client/README.md | 4 ++-- packages/socketio/README.md | 2 +- packages/typebox/README.md | 2 +- 23 files changed, 66 insertions(+), 31 deletions(-) create mode 100644 docs/public/img/feathers-logo-wide.png create mode 100644 packages/create-feathers/README.md diff --git a/docs/public/img/feathers-logo-wide.png b/docs/public/img/feathers-logo-wide.png new file mode 100644 index 0000000000000000000000000000000000000000..22ce3044271365138f1a0f27c81bca1be3e079ec GIT binary patch literal 18567 zcmY(rWmFx(5;cmuy9Rf6cMovT;2PZB-66oi-Gf80;O-FI-45>V{&ClP@4ox3T5D#0 z^>lYtckf-bXQGq=GRO!72w-4f$a1ohs$gIcfUjp$IGC@i<8^n;*A3i7RYn}FdXnfE z3``VEPEt(W6Z|{}wgY?ce%Q~I?mG|d?0i10Mo}S_lvu3^3!8iGP_-OZ$^b@Tlyofe z;O6fq+FuB8k)+FFV#TZFvz1q$AE`O-mp<#Sn@sJG7Y63Sd954*0xk#H9A;D5d>qY| z?RYIAsKQSk`75gaw+9mlggZ9qH9yqVi)yK-vaT6C4SMS_F+QUjGHwPe{GYZXqN8-v z0wH0EUE`mcnOc`bUXBWPo2Y`Bs=|7Mxb0SLjewO4~E^BDE* zW_T*(|C*T-DMm16-z*T0ora7w2kdVSx~DbV@oX@v9OBh1sb9pE38y^6NON$*x$JF& zvfyGL&vp){`u%mVW?Vk5G0VwnbxVsUom*V-x_k~U3M$I(fe12_2P%% zuKwCboH{Rzu>X$*ABt{5l~(JwYv|Pd97K#%od6(1f&;^{DU-_-<)pe+BZuihi4ID&~eoQ{^CISH6mNYtX zKX44(X4kYmcwf|?4+M{BTv%|<8=3$PN2|G$Q^nCdDHkeHpA6M29 z-gvs+#Z~?6-bcUE!8AYx(uA0(H2^-1<*%tVyfhVa`0vAfcdSmEzFriG1B;gFy3-t8 z`?Gr5%JB3*ohVA`+yr_+$^h4Q@Ws5%s{$C4vaw0|RjVgR! zqloVaWxWPtEc=x=l>!lwU*7t@pJuqo1h3+B|nkEq}`-tHyj zG`nBC+IQa+xp>`H=i&whNV)1in$<80Dmj^Bqhx}ygAY~#M!)P=g!S2MmuqpK5pm&T z|1Wo8(Zc@4$VO9k*Zy)oFH{6z2UVve3!NS~x$mb?ye5@N4b}S7k$?8lp3W%;m?Zzw z?V)Q>`Vf6S7cA`eLIgkIQ2}+I(_+*coWLHVgd99!_FvZ-@uBgcm@@K`k)GB0zrQ@9 ztCc9Ua%~}jCX3g4}sHPCO<)5EcKB`sKEu=9>V(YcpDuX z$nB+dZOR;owM}LFf&Vp8Nxt|55Tzm}&0&M$0#<=Blen4)RHV$UA_ceNEW7^UFyvd8 zv}J|OY@~%`JzXBH=VqMjAW%;tyCxKW|i~59t0l?dU7VUBkOCl^2SUg zE`S#+;CWD(6q0#1h17(chs1qX{8cS_)gI?%c_L5yzWGRhOB;SQMOJh?klO@>s?%)0 zVe?R3I{s`Wuk+tflT3iLf(Nj-4VB0}NSOOva6*N%sgTAn{e|t74+sEx7+x#$Gc~CB zTjomV`w2wwiK|hIe>YJ^*qw=>1}GZa%v^EOBg({?YCR%o#Uw}L z=nG1SXABe~L&&Y_56RiPW|jiJCdRyCV5K^^Tb`ir(^YqvMh3L)|2QOG4W)>Yw>3?d zUlS#8+py4RjuPPXtC|~PwEMdY^7g*K?ER-F6_Hf|0-yqEVy<&OAZ^AvsFa=Up=$J6Z%CXY3|6>|(Kf*gj)P}g z(SRBt-0MjJ#lx}sAzW0Zib{l94}M}nfABc(Wuwk~ffDh`X^8)9Z~vdc(| zjT_420!j+O&gg?6fH)#~N5qJdL`nuq?Sui};e{_pXoK#qh) zpPNtRZjfy6fh|npYy_qm`tvos#?2O^^&Vl2o+XwMt>z5(>Nb1QxF#=rF7D6Qb+(3k zvv@EF;q+dXWs@5*L=(Zf@>QI{Hi||OIeUrAc1*{2SP2dr{R<R?DNi zS8z2tD)rE3LBY-|IggN>RQ&N$_fRRdt`VP^2#>x@H3Q(+jwiCoPBpAjZ`# z;3HM*<`f6D5e48iDUqc59|}*2!*v8Q$>g|?weIQ!^Q1?<1n(|ox2?&;?D5Hv%Y`*O zn?Eji0u;X`Qf4Uvk|3`dx%zxPUW%AwH==ji=U`nG!%=j3fp?8XBM zc$g>Bg9in9QA8q>JLxxCFX(jq=deuu7e5T^*bcvLuN2%@$a(;~x%K;TfXc`(^fOaT zI7O^0@d>D4UxRkAevO`z@Q!pI+S{J%=&5gwe3gGDgQKjFf~O* zsety;LohC**7xI2_QzkuAeqv9B^W1on3e261K5~4&-bJOd45Vs!BU{qcWfNG!*W&2 zjIm~O$r8BfEy`LwuU)1Ni%rxw@@uk&U^RCkv5FmJLT)|TH59Pf3%Pu&1>rnyLs?)8s~ zTT=~Nfh6V$d3K(Vw?`+ce`t1})MHp-uELV9Wa@gT%wU~ zpcFT#DHlq3$4E0J$TQ!vA-j%WKhVf9m;9K5kwRrB^x^g7#3FueA$J3nJMLSpPZ3Mg zYV3RaVjorVz`zIA1|VxbXlRoA4*wCi_ZlTA562~aANwBUux2JVN~xH7;IdHhqm&h< zhHS2Dgk5z4O?Q!t~nUswji zDm=lo|D#$wnq!tc@yy^6mTX%)1$#N@sbq-}EEqi$E^OL;Kj`ueIHm{RPQK_o2K98Q=JWht0!1T%;z`2|G(es@E`-*D z_uAgH`WR<9=`iB?v~Vr`%E5^070Qd8%#$$qXpXq|3sqn0(0QW>2JCJlZu*J(Vnk=l zb^1JhaHpJGUq8KGb~`}Cttodw?)#u+R)G;?;n$i^WF~Eo+-u)ZW;h8-v8@?yOZ3&DeDfugPJe5AQ1fOSr zGz`!ArrV1LzJ%S$@yN};3iKa=vLEoh*s z(#yvfnlu;8R_t2RzSA2?ozZ*L--B>u`H8}xcXjD$SNOVt^ewzM4K+PaSQPJdyk(9u(}xJJ9dlr_Bt~6_K?=g)3XeALq^& z*Cyi}SQ)^7uKM$L{6K`X#WygIArW|!NwS!j!d+UK`Gy5^*63@Tf9h$s)mYHnN_|CS0qsbvdf;E z6=b^Q$A;j^4vmCel_2JQ$Dsp=J7xv%z&bMjgxV6hi}_4{O9NNhLi%jV6RxIF84k4t z!Twl;i=XyKZt?yFnOk}*n2vhHAqM9ivqlZ_W&ZH(Xea>|=5o#7dH~9|@DG9*PSO^o z2*_HKIRVL5$o{AyhQmyQ*@jGa4Wd4YUI!9}-lQrk3Uz3{L`Jz_^7=Mj--4%w(wow; zWTn7@s>z3dp{4a#?^li2Lvm{T|B13sMu(Yvh%ed=OI;}J`tftn$!BJT%2>K@rtDml zk`B|@S%w<6iWG$b(fFoOVGx+lh_})eGGzz4#p*TwYa3Sd`lE@po(VNz0``mh?z7Hu zIe(K3NQwu+v0oT1ZN05)Zz41jUC9~Rq$uS)#`k8KM%pldtcOnCOtaI?2n=rRX zHMNU;BILzNK8a*qn93jVofB)KyZzmjdiR0(r2Mi{Q>V)R%Ct)kk-cbR4kP zuXhBK+Ur|*Hw2LdbW~Q5RE~c6C4R1l(;WBAx40X{j@Y`_kP%#I+4g@!mwG28P`=lr zEpam~-}wCBp2DcfRE`Wg?T7a~O0wiK4OIaV9+gm-VW`IKB|5n5tqsXrNr+u7rW;ip012<{A@@CavesE z9}HKQCAsfjL^YfzOT$m!gp*m0l9Okh&p}cmLuap`9XLf$GZfK>=qDeVuLOFgWMKpD zJX`va!Bc56HS9OL-fhgGsRUiso7+k$((@a9D`3U}mG_~%}#(tA4J|V-TC=z@^mORMwwPuH*+*XZW5$&x3 z`yqY^kXPw?NbVtINh_z8NDb#V4sX;v??qJdsWG!E)=4a9@ogwOCPlh0W}JTpC$xh7 zo|OeF5B2y@d{G69Qa+ZeJPcP)ustsRQPF$V$lt<~?8%7jvE$-Tc%jxIFVHKH^(yh6 zUlXsXY{<4_U*4&#?wA5oE>cKDvZDKC+~k(6}_ zY-)G($F)8Egi2GB8*5Ek40|QulAd&9*g_JqFW7h}$%}zQB(tkmJ3Q_2=vtb8hCrNZ zntwLda-$BB&w7*WeCLcyvIxm?FvKx%=+9dn8U4Y^LhFe!puX!RWPO3F=#3@LuOaVf zlZ}LnC-MvaE#CCf?^v$+#n;OjW52&NF8ZV2ehHmI+I2#%xG6D)5474H1KxAN9FMQi zb^au}XZ9zbO{+J*n~11w_A?EU=0#PeLF6*ES;zT$iXPP8!2r{aw&AVplT)4U;L%9$J92r%Is%z6H8}4qyHBoFlPopHp&{!r~U}R=J#* zFO5q?SFZkjnVrNyRCZc3@0O*zW!~k&!(kqW*axJ;BmfPkha(e?rXG2vl;+TH=Yda& zm_o43vCnG{Xe?AFi!6o}*!{glCx;2Q^;wAIv!-<8Uo)A1hI7ju?Q>BqX@F7z-14?$ z|61AxYlWP5LY2 z(Xph;N7a;&srHIEps8nG<%yk;l_Qv#DK5}4u2_}>yKrNu&f6i)L6>hE0%aF}U8r{i zPRVZhgK1HYvlF#nu5!?qjc6G-!{CN$x7qRhT%H||2uUKMFrhz=E0aWBxOm=k%gl*_ zlKbHsMqrUZN4EbnO&Ffx{h9ThC-07&u|t7mX0d74GAW|BKFJG(p$JG=Zj+B_xEh-D zEV_xnEFFnhdBVPZV#>5DWzII$iq8;uhzY0UH^ztul0Qjw@^uIbCBeX%EXou7W`qqd zrjiz_#o^E~@pJ5MA@tcL1MZ!F-Ua4^r+Jh4u0RcQ8w3YXU`+8khWmy!8;VCKQ@SdE zFAjPIzclsLN_E_KMFFx)OYc&8`*vL9#t3KS8luSN#FCOXI&&C{XT?_PHrrq7)olLo zU>}aKa;DoZr*PLor5?+(B)#oJj+F5{&7?@6-Kvy+bfX34-@5nvLPG5D+Qs4W?s8;7c@Zz$oiv#Ei26RkQzgr=V`M8|q(i$^3@ap_Fmm zK8;o;%~ji28n-MBo8J^*9zB~>e7J%*MS$4W^;iMj^P?4sNV-7PrvLRuW0|DX`%?nn z4f+KkX!^=qNnZh%))A2r4JCilKRKxAgX*z0w505wf-F_klRpjqhP)GT7F-P?Nn^}8 zy2bN`7hlKTD`t{K*F7YC$=`{MAH5?>61E-0mY|R6j?d4gAwOO4PX96>(Yut)H*heK zWhj0;!W{ZFAqBRDCE)Qc)-3H5<;^J*SNl|5w$3Z;}8<+1E zqlfi>KFSSCT`;OG(eE~QI-$DRiT8(-GssX`w8In&SHmhYc{qiD_!ry@X?6R|>sJ z0H}Ki&wj05cZ_>}9go!`;)B$GRx6aW(AJfb{-wSPWL*QoG?BcGj>1&Ckz&bo3 z3KYM>*-4b4xHtCBZIKf@BA+n3 zmJ)uoxx8_~&^dN)rbs9xdStJnXB!pG1bX7%5NGf>7|1xrgRjZMJ8F-f_mhM?_QG$b z$Ob?0$Wuy!z&nZo9#H&O9DO!Wto5|D)^-Y6Z~epYc0S`*LNe?KKpj&g_k_w`nE~4k z(^!_^y@IO&1^>Ldg)7TNQ3ITjEGFj z(|L?Ek1`={(}DwRQxoHUS160F6=GAzugRKF8WgW=Si_iuho2~1uJ8mB@a0$ia8S|H zqbP7~K+~(EB$=D)znc<=x8rIDP`ZD~y%c5geZirGF)*(FeEWPYJy)E{NZAeg9z;rU z@BKAYV*z>0TqH!Z`r6Gn)F*)ZqwLrmFVi53NpQEV`i^j}fE^lkN0XZ%>vBLSczwu| zD521VXaGI4pz-S&z2k@WlX(C3vQIV!)J4o7p|4~0eCVYQP;b7o-Yyj_1of2+=@N^N z5>hmhsb&tWzEpJPA^^BrEoOy*jxis{O_$@oV$Eg9A5byX;NSz&FL=8W`!u9p%ULK- zow5*K*$;XZ#f>08$ct!vC!hqRH^`o@%Cc@x6tAmxlgd7s^#(T;j{BVW4-OO(k)O%A z9P?gXTJ0dXZAI8`x(TBx#27vsN>eh2+U&A~ZTlk!PG^Oh8lb-E9+71fuCwY(rk?o; z&-G4h^KqU9v5e9%H(f9hw zWs%2suKQ;3LVr5_GP}u)75;H1kzWKFh)zAALgtwpC`4-$pYiX5CZCV0*zKOFC&JjK z4DED=C4M$oQziHA2AO*rKzb9(p!VA#QdHff2YwzDz9_+MF!)W?MY6M5H=4e@f3u{T zoP=?r*0-DCt8nj2s}D*U`wKc}g2|8=-^-E560eefj8+L+VS9?M3_@+33=Bl&aZK-* z_f1yt<|ji4#I!U#M1!@P1cH)f9VlpiPw21bA%2)A1aKhYa2#M@%kd#s-GW~Y*V*l4 znQ-dTrA={DxLuOtO>^@w-7NjJlXL{+pBn(ptPbiO z*AT#y=ZGIW{Hforg9raACW-KBQ;Yq$JUm%waxaX9CBt)G!ZF9fk+Lfy3itcJ0*pE4 zdNiEPC`5hRrRT%FKTtH9S@dhv!(@2t);ms!84g8G&P|bcE=))DLALdfho0BLR}wEH zrLB9>?fXZzNfJq29(7Jvr;22Vo7i>3YipziK~T4K+?lAi%$H=c9<;GgPag(W9j`jN z7*RJ*V^{vB$&anQN=xejOxb>R+cdpHF8{z+K`@4H&Cfe^(I-=d$GW?E10FJkD-@XI z>pyDh-Q=FNFZOcb%d*q9DNf)4>IN)_aG{0;6udK&p9^{z{%*bVqymf_m*90(?bzAq zjz}JE7D>0nkOwq9-%`=@kFdO#BSyozJcm@0(WD)3`X})W_@Uo*lvhht`OR)~(){=H zL{12OB_$;uw*`{$QqYQsv0cf1J$c{_LlORVV7fW6N@89Xf9JAGh}_FAnyIrXcwmkz zlcMly%Ju0Ct@-Cm`xT*vHmC5_d1s(Df zfv~${IR!1Oclxvwh9(s0K10-%>*$CCpSXDZ_!}HK8IWK`d8PcJDj{&aY@LOKJT74J zTs;wr^S+=(v-29yJ<%~mDwxgw8a%@>^+LWb|(@f-VAZs6u@pdi;G(r zuIqT%mi-Xk%P=qyKI$6ZD`2wcxaN&OCg6P93Wi3+5tHyc5|Dnq!?zu=$;Lmll$ns2 zmuR}xbYcO9P~R;@@^@M7Xs%3rBIvj^I<2p(hp^hs4Ghe|>#yYi>@%j&S;N`g=fKey zIzFN60ucB-UATL>epwt*a*iO&nSr-b+0=GVlX8&417d^2h?qHFW+5Cs=*jM&XzUjF zNNoCK;Q>NE4}ZV`lU5^b zY#oafKhhMR1yk=4eKuw26n)=xwLSU}m4xD{vt`YOg|F!>ohbeL3PVIuc)hab%GNS? z(oIgSs*!_p^?F2sT1S<`r-dn`WjF&zp*lrSrTb%PX{`|8hgP6XT}gER;aiy};wwnG z3ZPgEj52g*Tu^k(5WK;NCkxBTdhKdd*Lhw(rbY-Fvo3mR_jF!vKkfh&<4=_-)NtYY zpXc(kx8Ife2Q_vZ9Jj^GN#;|b3&LgR&3{yCypyVUBh7X=jdYy*C94kVN)HbX4i549 zWA7U%HQLVK9#2)&y(X6T$Xy*gS}yARR?Nzv+Z?y(zV=X2V`m}}<;$@@C*vKLI)^v- zA$S60+FLo(TBi`)-Zl+!pdz43B%p!H%Y+$$+J-1EIo7JWLm_adihm@M92)W_d5aw? zXUr5@6$g%oH)}@d$?Wya!2qv|&Y_aVj9UHs0ydyCuRBEl5l`E+V#{p-o3b?aD^j z6k1rx?g`LaKFdcrdp8o_gJYm+M*VZAx}$&l4b3g4wKQaZ$3y%of>F9wUKSuBP9RsS zWa*86bdH^3^tuYo;8poT)=0v9>!Qs;Td;tUMTe9;@~W3rcVd$4K%+mIOG9ybojq(D zY@R*}?Ly60qW@g&k3dZW@8AemElAoOV@XsJ238LQ(*vQB!#K|Q>;62d_|quX3S7cZ zG;jeJtCd*qdLz;lJCwzTDh-op$*wmQtQepf)L8M;3Uju8U%~jAIUe`JZyoS!XR!4M z;?6HhCO1V1y7wGic1Eb8!;EmgXHXzdH_S6!CV1?2L`2HuFU-7%rOn}>%QSy z)m1`gU@mcpg3zG+HYpW4^vPz^BdIN!T*gFHGI)!h*SG+lh?@3jhJgII@)rwgns4pp zjP{soDJD&lh=7`YwGNUluhOT- zaS<;)d%_|LyI7X#cNaD^!x|vWx`xII$;w;zOUgt|z{Yd4b~Fd8m4{ExnCKb`nfP4? zN4?MhhT3eAny^dlg2dgOM8MktvHe6xjC!hew8YCFNGZ{1tp@(T|in)HxuAt4*dEf#T~A z-1$JYq|P`U{s!LQB&+DMZOx;n9*_FWwQ-U?Ad958wxxox9&fDEiPPOmcIx~1xi3~Zi*o~Q$0K7|x9 z&)wzp!f2Fsp~R$5(WANs%|dBHBIj#oun;rK zMWhP_aF}x#T(RPiQ|O%<@G%!($Pp?&G|tJr9quR$og13ApUKDBs&k8Tgb^dpv;Wkx z{^<}Nc*jEUfv|HLM&kJqc-N88VD1e7b?sv*+p0HD7h>0CKxH?{iY6%{L_x08?GUr( zD`B5Oo&B8>3F1bKD)xe`w82q+&jW+N#MkW9lQd1%iD&*!GVle+W7Z~|+Q})14X)pB zhZz0ZwE4{x4Mx3K6?B9p9`g{}<^o8rw^c%(s^FCCm+jghyPGfd_kQPspv>Nz!;&og715*`01hmjGyxP=whVZ!Ca0}~ z>Vx&Ay*$y@`6`18Hn=Y75AhO=)%uWh%bIW8w#z)zPY8`?hl_U>w#il3K z^egSIJ+bMORl*gP%&!1=B7AgEfN%)CsJ@bW94~d{+3@1TC3&xchGbT{@PO$X#AAQD zMJ9|5uxzs)dZ;uf!6mgZY24kuKBUbocrCw*d}O<08~ODvYO+p%o{nnYOq<)O`%kV_ zJOToVerC{SsAm>7g9eepy0+)j@pjHd6@Su*7fw>m=MS<$Aql{sfw+Kgnq_!qq$EDlyMANQ(6u*I6qaH-uM&&_F{qs;& zKNJQ3p?z?Pzjv|hx;vaKXMI%F;`b>*o+Ma_eg`_!?L$5gv0Hx-)V)8f#Sw}4zx5>} ztSZ#)2cl={L2zR|rKdQyVCdZE{Vj-Dp>>0D*Y5()v)Nzq7r`@|ydH=fyo~Z7@{M1g z70dNHpgu@-y92KDV!!W~`_Ku2OY7L@qJWmouPkKN0Ni8Ooa=@URUW$4U*s7C$I(5uOQZ6~mK zImq^&&+8N+29j31NFlx(oKIA@oDJ*Hu0v?slZn7W@s(6gVyzCSg9}sE_(UlJDykCr9rxn+ndCE(Zn#-~sW0xLa+n<>*7FnwuYrqWFPf-_#Nn&GgI$bHj7-Am8(w>|k~a|jYuTiI zL|Ie-$v9t*sf(#4hO_bSkN=c_NYFDs5R%+y2KHP|BfBG5IaBXg;Jd9?8;%+6+Fx&q zu*{t0>GCET&Yi%>e3E9Y#oslb*w)~1$!)&a@COC2)#S(g{p0s|asQRP=U3&~y>`~m zCoWY*uP)JC!M|~t3U5pYrJn`!qemCQGL9JJvSudbSG-`~Rik%CIIYZ^`hmt|N$wKA zqm9I)v~@3c_j%+Nj zAr!xQAJ){Y?8uPnmd=P^&R#~1y;S5&XoH2Pf381emFM?K^z7s$1Otd3CrKZ-{ zs946+kX;9pp&0EUs7*9I+#*S1Ne;3y?jRVsVU$aXU*^4qQhAB*F%mS86W!nGJXhz) z;^&yFKykJ`nQi;7!RPpIq8fJfb3taeIw+?7K|`^GEd8SEfsQ!y2fbf9;&HjmX%Ub2 z_nk$-mbPF(jfYt)!U0tiv;U!!gx)$%yX!20q)v~}(d@OR>%#qYW{nXNl-W~)`0-Du6Kp*__sQA8eXi3zU z+Ig<|%39>*d_}|ZdkLD3-b4JSO?@GRZy?oT=d!~AnD00VMeGu%c44jSu&c{+%t3MZzB5}7iXV2@;S zL6Ysua?8WYI7)}t%fpHW&kw$sxkC@fqqBkXZ~)h#iKlJ`%-qxkWB@0`B) z==p~`oaCF^==`G3=!){yDV(Z3}Ds+E29%QD@I<9P% zf~>r&1M{eqQpmG&qP>nn9f9<9B5Wl3mkC)Y9jg5z_~cNqzKEXmVwv-_Xv%^O^fVdWJB z0Sv;D+`6>(zN0@xAsazYE%Ow5WcatN)}&Q8!`mwW?=S80$eZTG=TrK-zfIQBNLTsQ zgEQM)P?76el5DptR*vS<5;M-K#Y5q`$ug}M{1IcEB{}R;%|&=xAT>cKwPyV?ysrIi z;N2!+dAd)Kyzo85GLJj`Z9WQlrxz>+#Po~>H8ba%iI)smhfUwiov<~Pw)rDANf<33FgNK>wk|z zV851S?(^P4dUWyb;_VRWCVlEZ-J-F5Fu&Dquz!_&a;^W&1?CYaoq4I%)bbqK3bCn%%%mEF9JkUzglq4)T_d24b1FOcH$ zJ7$~-+=qtaFO&Y_$lD^hq=UqJ7qikT53_<*?Q3yIUy%wiHQ1THM-#8DF28OdnZAFl z+B@FPWr2dOX9HTzk7`g+qAkmW@r~P`5jxkWtL=Ul?_I91nmTmokC>q-&myITg2on9 zB7xqnd)K$5v9)j4I{&0^`hr#)ZQ_3CDCC{|0yiq`AjNPjz7w;u%Be#LO`Q(3u)x_o*KxH4kZEyHAatD8) zVM1?|_!HatJ*?GNH`ul@8Hz^bUtPzi3P^bHIDg3r`g#A?;Xl4rDq)BpGf3(xIdIMi zTquWyuNIEPpqm40{nca&;T3E4y+CHc!lP4rr;SFp@8S96KadCo^qFe2qUYBzX#m-p zIKg@^2eAyEAlvA)6p@O{+UPgTmW3F4f1Da4UQrUiMcDE@fZ%iPE>Y()=~VLt8)lqZ zWbL)^6aVLE&tt7jwj)a{L%WQ5seJI1 z1{UlzoU1{zoCo*#K{vi=EfZ2Z-;m-irx?VWZj$*#xBUO5Ju4UrPR>Ll-ArphuCnF;U0`ipQ_>xSsroAMAd`aj7i5sF2_znRk4Z3e$dy$5f4Q*nv6La zS{{><=Uea#2$KvXkiNUYKLs4@bZKTcJ~hbL&A|+$l~VD_=`ZJtg>Zo71L-9?Xg1VL zV9aUB9>nDJdsOxL2})@Z09QMb=_kIv$E->mWi{|&WH^?zM51iGC_RP#iQEtfyVp%}B9rS=_Na`GBBV&FNDqaz z<#T(?6}OVIdm`@g$6X=OUW>~6%-|heLmnM*S^gG(Fy?;d-xn?j**ka`3C*>=bac^S zSIYp+2>xjRFnjq{wIMVmg`Wf+$XFt|cYMXYwxrC^5I9f5W2UUx~bxZ5l_h0Vd z7Kf01dyRO7SM6%W;BAMrH7^|RFVpH{`vN3SIMucahZLE$uTw1mejNjhDp@r|!qNXA`2`zLr>wke@>a7E_@_O{g8| zA$EkH`>8uKi{XCjzpX03AB}wO@%*@IBTX7>1xQtS(wNPAwR2?nO6Q#?(8s9XIQ_n4 zx|t}JxbIO?ELPC+N-v5F9#S&4q&d-w>qZ)RvG%wM|4|i|rHhiSu27`b^(OFWZ0OkLdFm=0b@6mU222Z~c-TzR|0aY^rr<_$p zZZ}m8g%rOq=mZ;VdI*hjG2h@H)XhpVrX9%QKNeHDT+2WG(eo#9IJPAi-8WGi5(OdV zq>5vvX!Ni+r7wTm#c&J8rKcF)*BbXT(`ef4hlbNNjII3=z>Fnd;VrM8Zqh>q2|o?8 zn$d7d6s8YcPB)2h*D7i+^wO(()E~v6-u`4AUer?*&VLM+VB_WG3FdHeH}A>pwVrM? z9_JIynv8&=2s|?J6>!HKmdap+dhrK6lXsDO+Lt&OoNQKSbFaqi4*P~xn@Q=7JrZTm z?p}j&2Jdox3&Zm4mIE1*h5xdNCEzkeJ^WKr{yMG9P~W4r-4ol;uV7ZBbT$g{*qGlX zR<53F|IJSghsEHJ@S3(+uO9(5Yh6PnW3>Ab!GMoUh;;j%b9bQ`_QibRxz-@?FY*;x(bvc3aU0sHclnKIFF{D>!h(nvVlD zg&PoYIn#~}2%W0BVyY<950%f-cf~A>D%7h*kZA?LnBO2J!xeBB)bk=00eRs0KBJbUE^#zYCIH+s>JG}QUktytwM1Mx|@LIL%q zv%k-J>bP307leqnFuUQgj` z(=D8^aUMO}V%t=DcqRcq&!C-=@~{_|dTs%Ds>4##Z=`F8#_(UoF|`MUX~y06?r6Q{ z9z4gn)aT!lVEMh;p!ne#1**{`MFPi9d9Mjn=fnQOKe&;)qAObpe4>VUAs`l?ZmwW4 z!bY>lU5+7zM+IXT6%@f=Mxm_;P12l&0x0FTpkx>8mSwHld-L6H5zGdKhAP7sxBSL^p*zZU{1`t7Mb zFaD&hG1ndLQCuom0CA6E-=+n~8=>H%*%qNP2#7Rv`<%`Q#OT6FyW#^`vr#^ETUr-7 zWJ|mi`YH_YANQKN;1i^=^b|%!CxwR0;XC~8MH~lL@_FNV0y7v-y*GtQ@AS1Qkg3yl z)uRCegX8+ozW~(A$67if>~O78JI+;C_wtx@8h8aWruWDnatIe;hrq=swdBEvvi&*H3A%V$)ZTHR2;Za;ZPYYRnd6fNl=8>BP_%RLl$r!vIU`1HZ`WAWV zUn=P$UlyFS4Tg<+sJ?E%da6F#)pI(~ALY73$9jtR#>Ee`x;f+zHCF7|mhP+Ru_A97 zp_Z>)fk)~v@D*JBOOT#y(_!m3vkm6w3F-I5$(k6HUste_^l`)NcX+P{hw*nV-a3mx zgfsjj%%iCsZtLgG1}xG42|NeG_@5&lxC8DTj00^!8Li5`2ryHj`}VN6KcwB#{D8J# z7UNQfL#l{C<`Qk0pUT+0s=R9l$oHMEjuN zTR53<0O4so?Jv#F$1VhYd(@A=!<-`e(b0tZ0Qo1DO(6d+emGL!XePvI#LYw%;FCLA5r@OnIh`H*db=nRRJrj))To1&I}5N`i{kaxxK z&54Gr&*~A)++qf)b+3)!gk^%vO zO1J$2c=r@-^O#Hq0<3a7EkLn(lP2;Q>OG0jS&XR;>Re86Gkx(sJtuQUSV;Ch)O4-V zk;2ac*)t%ZwEe+CDj&l;tr)(7fipQ;{R46HflmoH;1)5_>`J+o_*Oi3p#=D!)#3i&q*J zPTCwq`3?wR9SJ+qCwD3Ze;MgI@pm7Sz1fB;l_i`<7r*O(em!^@mA0u&g40-N7VYn) ziko1fp=p8OaxgRQcZrfPHNy6DfFU7<^#O? zj(1ZDKZ3_oc|SGP`IK@}k~F8RPRZ><*>3o*cu!a&F1MOI4*>tJRA3ivDU;t{*=&p$ zF`_Gkod_l(Y|kVZ>4PNcQ;b|eT&tB8ibHS_1ELmbwRqMFW(Ptw!XEfUM!cGcWyd5f z*Gov4AChmIbyjf7tm*ks?!X7XKc&yZ?^XtsrM#Psmx_KRp|nNX)~U;L9bZ_Rv-4VSvKS0}9oaR~~$64# zjrAwl3LDIXHYZ6vDJ5$HWsbO%%;y4gha`ov5}XW7##1|Rzmn(P)Rl@rWCf=XHBP2o zOh{koLSMLywvm8a`XlOOqy0AWelFoJgewVG5w0PuNrpQ3x;#rusnF48It5GqNJIJx zUINpUlCQ#hij&}ExF9)z3n!%s(p;)tsS<*x$)^y0>f0}k+A_bVOhw*lZ0|^1TDNBS zMBjgsJ?-;Ll)0Pc`PoTK;V0o_l|s2tv&h~Fn}%)>u9e?`gc5#gWLc?J=~_`tAsmg- z*I3<{k42j07!NO?!b zl>xvF4214>nmc#y;ox@`{xATWZK_P`&`Mm!))Vosa13}<&@}6&=A}!Qw&KItj0IOy z>htU=NSlY2L7J&RoXa20VY>rRTXMCiLv6Sbznc0N6Mj!PKbbuR?@Ks7ir0}}wmLts z;2TonWy~HJGgpJMwk&^vmM3zJzD{#tn5+X!N6|JNz$2Leln!b?0!uq3Id4+b78PMzap)AHU zzozX1K_u;3(<}hvq;Auyv?X!*h7c{ylBZ$fois?E21;@KPozs&nwgF?Nq*}r2eRS- z1HUnvs6zm z Shared utility functions for Feathers adatabase adapters -## About +## Installation -This is a repository for handling Feathers common database syntax. See the [API documentation](https://docs.feathersjs.com/api/databases/common.html) for more information. +``` +npm install @feathersjs/adapter-commons --save +``` + +## Documentation + +Refer to the [Feathers database adapter documentation](https://feathersjs.com/api/databases/common.html) for more details. ## Authors diff --git a/packages/authentication-client/README.md b/packages/authentication-client/README.md index 8f71256c0e..8d3dc0fcd5 100644 --- a/packages/authentication-client/README.md +++ b/packages/authentication-client/README.md @@ -14,7 +14,7 @@ npm install @feathersjs/authentication-client --save ## Documentation -Refer to the [Feathers authentication client API documentation](https://docs.feathersjs.com/api/authentication/client.html) for more details. +Refer to the [Feathers authentication client API documentation](https://feathersjs.com/api/authentication/client.html) for more details. ## License diff --git a/packages/authentication-local/README.md b/packages/authentication-local/README.md index da66818501..ff8c192949 100644 --- a/packages/authentication-local/README.md +++ b/packages/authentication-local/README.md @@ -14,7 +14,7 @@ npm install @feathersjs/authentication-local --save ## Documentation -Refer to the [Feathers local authentication API documentation](https://docs.feathersjs.com/api/authentication/local.html) for more details. +Refer to the [Feathers local authentication API documentation](https://feathersjs.com/api/authentication/local.html) for more details. ## License diff --git a/packages/authentication-oauth/README.md b/packages/authentication-oauth/README.md index 0ec7b94f26..cd6d96ecb0 100644 --- a/packages/authentication-oauth/README.md +++ b/packages/authentication-oauth/README.md @@ -14,7 +14,7 @@ npm install @feathersjs/authentication-oauth --save ## Documentation -Refer to the [Feathers oAuth authentication API documentation](https://docs.feathersjs.com/api/authentication/oauth.html) for more details. +Refer to the [Feathers oAuth authentication API documentation](https://feathersjs.com/api/authentication/oauth.html) for more details. ## License diff --git a/packages/authentication/README.md b/packages/authentication/README.md index fa78232063..dc31fe0651 100644 --- a/packages/authentication/README.md +++ b/packages/authentication/README.md @@ -14,7 +14,7 @@ npm install @feathersjs/authentication --save ## Documentation -Refer to the [Feathers authentication API documentation](https://docs.feathersjs.com/api/authentication/) for more details. +Refer to the [Feathers authentication API documentation](https://feathersjs.com/api/authentication/) for more details. ## License diff --git a/packages/cli/README.md b/packages/cli/README.md index 11ccaab417..026a3a27b3 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -19,7 +19,7 @@ $ npx feathers help ## Documentation -Refer to the [Feathers documentation](https://docs.feathersjs.com) for more details. +Refer to the [Feathers CLI guide](https://feathersjs.com/guides/cli/) for more details. ## License diff --git a/packages/commons/README.md b/packages/commons/README.md index 671f53aa7e..adc4469947 100644 --- a/packages/commons/README.md +++ b/packages/commons/README.md @@ -6,9 +6,15 @@ > Shared Feathers utility functions -## About +## Installation -This is a repository for utility functionality that is shared between different Feathers plugin and used by the main repository. +``` +npm install @feathersjs/commons --save +``` + +## Documentation + +Refer to the [Feathers API](https://feathersjs.com/api) for more details. ## License diff --git a/packages/configuration/README.md b/packages/configuration/README.md index 2caf19adc0..fa6c7044dd 100644 --- a/packages/configuration/README.md +++ b/packages/configuration/README.md @@ -14,7 +14,7 @@ npm install @feathersjs/configuration --save ## Documentation -Refer to the [Feathers configuration API documentation](https://docs.feathersjs.com/api/configuration.html) for more details. +Refer to the [Feathers configuration API documentation](https://feathersjs.com/api/configuration.html) for more details. ## License diff --git a/packages/create-feathers/README.md b/packages/create-feathers/README.md new file mode 100644 index 0000000000..8d39d3b4db --- /dev/null +++ b/packages/create-feathers/README.md @@ -0,0 +1,23 @@ +# create-feathers + +[![CI](https://github.com/feathersjs/feathers/workflows/CI/badge.svg)](https://github.com/feathersjs/feathers/actions?query=workflow%3ACI) +[![Download Status](https://img.shields.io/npm/dm/@feathersjs/configuration.svg?style=flat-square)](https://www.npmjs.com/package/create-feathers) +[![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/qa8kez8QBx) + +> Generate a Feathers application through the CLI + +## Usage + +``` +npm create feathers my-app +``` + +## Documentation + +Refer to the [Feathers guides](https://feathersjs.com/guides/) for more details. + +## License + +Copyright (c) 2023 [Feathers contributors](https://github.com/feathersjs/feathers/graphs/contributors) + +Licensed under the [MIT license](LICENSE). diff --git a/packages/errors/README.md b/packages/errors/README.md index 2c94a884ad..3b3af769ab 100644 --- a/packages/errors/README.md +++ b/packages/errors/README.md @@ -14,7 +14,7 @@ npm install @feathersjs/errors --save ## Documentation -Refer to the [Feathers errors API documentation](https://docs.feathersjs.com/api/errors.html) for more details. +Refer to the [Feathers errors API documentation](https://feathersjs.com/api/errors.html) for more details. ## License diff --git a/packages/express/README.md b/packages/express/README.md index c6c3e5cedd..ad6b0f83ad 100644 --- a/packages/express/README.md +++ b/packages/express/README.md @@ -14,7 +14,7 @@ npm install @feathersjs/client --save ## Documentation -Refer to the [Feathers Express API documentation](https://docs.feathersjs.com/api/express.html) for more details. +Refer to the [Feathers Express API documentation](https://feathersjs.com/api/express.html) for more details. ## License diff --git a/packages/feathers/README.md b/packages/feathers/README.md index 54b64c67cd..29b8ef6b56 100644 --- a/packages/feathers/README.md +++ b/packages/feathers/README.md @@ -17,16 +17,14 @@ Feathers can interact with any backend technology, supports many databases out o You can build your first real-time and REST API in just 4 commands: ```bash -$ npm init feathers my-new-app +$ npm create feathers my-new-app $ cd my-new-app $ npm start ``` -To learn more about Feathers visit the website at [feathersjs.com](http://feathersjs.com) or jump right into [the Feathers guides](http://docs.feathersjs.com/guides). - ## Documentation -The [Feathers docs](http://docs.feathersjs.com) are loaded with awesome stuff and tell you every thing you need to know about using and configuring Feathers. +To learn more about Feathers visit the website at [feathersjs.com](http://feathersjs.com) or jump right into [the Feathers guides](http://feathersjs.com/guides). ## License diff --git a/packages/generators/README.md b/packages/generators/README.md index dd5d217193..31f0d844e1 100644 --- a/packages/generators/README.md +++ b/packages/generators/README.md @@ -13,7 +13,7 @@ npm install @feathersjs/generators --save-dev ## Documentation -Refer to the [Feathers documentation](https://docs.feathersjs.com) for more details. +Refer to the [Feathers CLI guide](https://feathersjs.com/guides/cli/) for more details. ## License diff --git a/packages/knex/README.md b/packages/knex/README.md index cdc2ae22f8..3d5d788ee4 100644 --- a/packages/knex/README.md +++ b/packages/knex/README.md @@ -2,6 +2,7 @@ [![CI](https://github.com/feathersjs/feathers/workflows/CI/badge.svg)](https://github.com/feathersjs/feathers/actions?query=workflow%3ACI) [![Download Status](https://img.shields.io/npm/dm/@feathersjs/mongodb.svg?style=flat-square)](https://www.npmjs.com/package/@feathersjs/mongodb) +[![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/qa8kez8QBx) > Feathers SQL service adapter using KnexJS @@ -13,7 +14,7 @@ npm install @feathersjs/knex --save ## Documentation -Refer to the [Feathers documentation](https://docs.feathersjs.com) for more details. +Refer to the [Feathers Knex adapter documentation](https://feathersjs.com/api/databases/knex.html) for more details. ## License diff --git a/packages/koa/README.md b/packages/koa/README.md index 6f2b0e9948..8b05c90c87 100644 --- a/packages/koa/README.md +++ b/packages/koa/README.md @@ -14,7 +14,7 @@ npm install @feathersjs/koa --save ## Documentation -Refer to the [Feathers Koa API documentation](https://docs.feathersjs.com/api/koa.html) for more details. +Refer to the [Feathers Koa API documentation](https://feathersjs.com/api/koa.html) for more details. ## License diff --git a/packages/memory/README.md b/packages/memory/README.md index 635c9d36d9..3e7e8b67e7 100644 --- a/packages/memory/README.md +++ b/packages/memory/README.md @@ -4,17 +4,17 @@ [![Download Status](https://img.shields.io/npm/dm/@feathersjs/memory.svg?style=flat-square)](https://www.npmjs.com/package/@feathersjs/memory) [![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/qa8kez8QBx) -A [Feathers](https://feathersjs.com) service adapter for in-memory data storage that works on all platforms. +> A Feathers service adapter for in-memory data storage that works on all platforms. + +## Installation ```bash $ npm install --save @feathersjs/memory ``` -> **Important:** `@feathersjs/memory` implements the [Feathers Common database adapter API](https://docs.feathersjs.com/api/databases/common.html) and [querying syntax](https://docs.feathersjs.com/api/databases/querying.html). - ## Documentation -See [FeathersJS Docs - Memory Adapter](https://feathersjs.com/api/databases/memory.html). +See [FeathersJS Memory Adapter API documentation](https://feathersjs.com/api/databases/memory.html) for more details. ## License diff --git a/packages/mongodb/README.md b/packages/mongodb/README.md index 2d88eab7ea..baabbcff6a 100644 --- a/packages/mongodb/README.md +++ b/packages/mongodb/README.md @@ -2,6 +2,7 @@ [![CI](https://github.com/feathersjs/feathers/workflows/CI/badge.svg)](https://github.com/feathersjs/feathers/actions?query=workflow%3ACI) [![Download Status](https://img.shields.io/npm/dm/@feathersjs/mongodb.svg?style=flat-square)](https://www.npmjs.com/package/@feathersjs/mongodb) +[![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/qa8kez8QBx) > Feathers MongoDB service adapter @@ -13,7 +14,7 @@ npm install @feathersjs/mongodb --save ## Documentation -Refer to the [Feathers documentation](https://docs.feathersjs.com) for more details. +Refer to the [Feathers MongoDB adapter documentation](https://feathersjs.com/api/databases/mongodb.html) for more details. ## License diff --git a/packages/rest-client/README.md b/packages/rest-client/README.md index 98112ad9a6..37ccdd7c41 100644 --- a/packages/rest-client/README.md +++ b/packages/rest-client/README.md @@ -4,7 +4,7 @@ [![Download Status](https://img.shields.io/npm/dm/@feathersjs/rest-client.svg?style=flat-square)](https://www.npmjs.com/package/@feathersjs/rest-client) [![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/qa8kez8QBx) -> REST client services for different Ajax libraries +> REST client services for different HTTP libraries ## Installation @@ -14,7 +14,7 @@ npm install @feathersjs/rest-client --save ## Documentation -Refer to the [Feathers REST client API documentation](https://docs.feathersjs.com/api/client/rest.html) for more details. +Refer to the [Feathers REST client API documentation](https://feathersjs.com/api/client/rest.html) for more details. ## License diff --git a/packages/schema/README.md b/packages/schema/README.md index 4cd891f48c..ed4588006f 100644 --- a/packages/schema/README.md +++ b/packages/schema/README.md @@ -14,7 +14,7 @@ npm install @feathersjs/schema --save ## Documentation -Refer to the [Feathers documentation](https://docs.feathersjs.com) for more details. +Refer to the [Feathers schema API documentation](https://feathersjs.com/api/schema/) for more details. ## License diff --git a/packages/socketio-client/README.md b/packages/socketio-client/README.md index 253134418a..8cdaa10192 100644 --- a/packages/socketio-client/README.md +++ b/packages/socketio-client/README.md @@ -4,7 +4,7 @@ [![Download Status](https://img.shields.io/npm/dm/@feathersjs/socketio-client.svg?style=flat-square)](https://www.npmjs.com/package/@feathersjs/socketio-client) [![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/qa8kez8QBx) -> The client for Socket.io Feathers connections +> Client for Socket.io Feathers connections ## Installation @@ -14,7 +14,7 @@ npm install @feathersjs/socketio-client --save ## Documentation -Refer to the [Feathers SocketIO API documentation](https://docs.feathersjs.com/api/client/socketio.html) for more details. +Refer to the [Feathers SocketIO API documentation](https://feathersjs.com/api/client/socketio.html) for more details. ## License diff --git a/packages/socketio/README.md b/packages/socketio/README.md index 9198dcc606..4c5214f56c 100644 --- a/packages/socketio/README.md +++ b/packages/socketio/README.md @@ -14,7 +14,7 @@ npm install @feathersjs/socketio --save ## Documentation -Refer to the [Feathers SocketIO API documentation](https://docs.feathersjs.com/api/socketio.html) for more details. +Refer to the [Feathers SocketIO API documentation](https://feathersjs.com/api/socketio.html) for more details. ## License diff --git a/packages/typebox/README.md b/packages/typebox/README.md index 0f308fb9dc..9d11794398 100644 --- a/packages/typebox/README.md +++ b/packages/typebox/README.md @@ -14,7 +14,7 @@ npm install @feathersjs/typebox --save ## Documentation -Refer to the [Feathers documentation](https://docs.feathersjs.com) for more details. +Refer to the [Feathers TypeBox documentation](https://feathersjs.com/api/schema/typebox.html) for more details. ## License