From a9b1beb6af84b4d8e1c27177da7d4322e180f60c Mon Sep 17 00:00:00 2001 From: Corentin Thomasset Date: Tue, 18 May 2021 12:39:02 +0200 Subject: [PATCH] docs: updated README.md --- .github/logo.png | Bin 0 -> 8000 bytes README.md | 50 +++++++++++++++++++++++++++++++++++------------ 2 files changed, 38 insertions(+), 12 deletions(-) create mode 100644 .github/logo.png diff --git a/.github/logo.png b/.github/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..18bac95080859922223d82aac99703971011c5ca GIT binary patch literal 8000 zcmeHMdpMNqyZ&YnQ6f3ynA$CsOw@A7VT_~$Nhg$X2x~=TCT1MRFs+j0RLi24Fk=ac zaY&3A=UPZ&1~JZ4#0;HJ9)E-uJz~=Y5|0x!+sd zxw9v?N~=l(0I>D+spA&_K%4^r5P7Lh;FZSo$3y_ol01Ff>QdOi%&^{rORedfKFCXn zLvJB=o!E6ELB#-ii?a`92)(t-sIT@W#aMJhPU`P_@_XdIJtZf#yV6JO79zp7^V>bq z*wU3@dm~lU#h!&$%-O6WcHA4zy=nt&Pis-p`baxbD+*lv|3Cj9fgcgr=Nk|((;_=V z(vcEf)W|Rmp6ZSoWUVhz3?1Y|mrUgt5b&qro;X(Yr~Yn;hUhop6hcz;yJtIiyFvOg z5-AKcda_o@N|Poe9+P;}11qr>))^7$(FP+G+Aa|jvF$Gzlfv_&QRH~bk?JpV#DQ+` z!NMfbgO#2&{?;$0Y<@fhm4RduI>MOZSbZhYl2Ql7u~5@7Hw8xHS17wmN4$#5Y1|3#J`5zLz|4y>lzBg>!f^nXKW_G?z6Z z=(KI=KhYAnRM{&?&05huqBl(>$O3>9LJ#8B6w_%@82hYNDp~Pa)~?5DqS))7hthIm z9uktK;%`DUzF+hFKYnd^{VAQDy_~@7N(wX0S!}(9UT8JI+$O-1AHHU(?CF$U-T?vh zPygdBhbiQel8uZk`bz(erIV{G`W58&?z3~$I{S@b{sKQRT^F58bnc=nOk(hil;L`* z!7hyXldPG=g)_7HO9z{8`e_LmIGdOed^gb@mmIP zye$M!$t0kzd;SM0XLWaEj~Gq;?OK*|f23-5ZDJ~1zISKqhK|$AT%RDrk|ebp2l(Fy zs^7!T;G4YTA#Qhq!X2l$51U(xKcd`!^@%wM0IwAodU^@s*h?OFO1u!tg}q+6mx_KV z%x+-yE0?M6>u7c9oc$vuTz9VJ{^}>U8<>o#rDi86O@r7^ehV+Jj;T(bpEC6XEAO`A zMJTQ5TjqUsl;#9Ij1K<0CkO|d_l{vazd?*oJ-MeiO_;T`&k0R_J9N$t@yNZcSsY%@ z+7jxWT8!Qg0IRU);@J3jX^2LT^2fsMjHZyL%}Oh?qoqP8=h1g;zQ-8usuzBHp^#_4 z*E}-_@u;PxSNt~hr&n$O@Y8Vw<)!|1#(BK_NCe^$+6!+qH@favbl5-FVSXnjRA)pd z@Jd6)z@e4L;A_%4 zXS6GOzwFY9?x~3h^nn=lszZJ(ayXs*m5%zK!Dt6jbQ$QpuGC%TA@As{4S;<23sMCH3&I5mD9Ir z!|y{t#b6y707R@R$1vQ<*t)Z${aQJDl6`xDFX%h_WTF9Mu#M-N-@Q@yaDA4^kCBSr zs&Zi%*?E%}?3dg%Tk~g>dz_-J$KvTohk(CL;`ACP*%Rk{b~J~b<}YhQhK*ZVsc^9_ z69s*N@Xy7?MdBlgyt4E|b)o#n)CZRAZFc0(YGY2Wpi%;PUKA7U2@(b$YdIM@l=LB> z-pa1%#uGZbKF@381WS4EQ`X#IAO3f`0`~|I|6w*te4m@sv)qlPuvKFiyP=qlks&5f zX=S~L{iwxu-9B45H(x$OP!?o>ZnDs@x+%L+hf`n9g90S_=w$?@>RW!ndk82vaieSO z0J-JpAG(@F#|f#4xifd*p6lBBRQ2K7H&4p)f{PADQMqnA&D)KCf~HU*vLAj!@m;2a)}FP zQFZ_Te&hTB64I3*CCY807s7e<>WYcCADl>39jkpxUn$d+eaq5}K>iBfAb-N$Q@rck z+^4BJc!GMOc@|75=@K6{Gqaxh3F%-+TL-lLSo6{Z_N~4XVoL+xXF5GYDCa2#U>YfW3CPR%s zX+955x-YYTzW?sr7WB$pC~)=Ou`55KoJ)YA1N4F+Rz*Sm&x%Sn3O?*aX^pYee7{)i zSAVSe%=ewf{Ue)Y?qVP1A2wc4WCW{^Y3&A{ykVVU`yt0A0Yr`{q4n>;wf_FOQti#8(W?R~^kIax{d{6}=JiOlFse|ke)mW|3pa%o& zyKqnz%(`=e{*3R}1b`5*z+LW1aa8<@3^f={o@<3KZ2j{i`@RUFx|JQNQ2}KUu(d(7 z^g?US{>9TpsEqb&beV%#|2y|~9eGGDrVFeKYoI9x05UxXrYB}{YUODYVD!-HaAFure!bz%j`W=Y6VI3;nv z0IiuOy`(C`sf-3S}JP#7cU&UbJOal8@C+q==f)(OltP@PFk1FjuBOor?p{NdnAIgc*@|DPG=s;RRdj5{i(?Ho`LmR^06@x~Z~Z|O z`<;wjuP=9dFdpxyl$H@ERo%LxEa7N)26x%qooQ;kAkR?j(_Dik61}hC0bu!szC1$@ z1~%9&hP~-vVJBT4FK5@Kp|{Ooubf~q8FO38T8S2d3X}L^?)_IBrs}tSuaQlyN;O&6 zI0B;o<-3r`Zg#;y+%g`exevA^`4nsTm6lLw3xY`aM()^bbmennN>tkoBVo>%&u70x zjI{^eadgv%DpC&pssh*_ZNUC0CC@N;f7u^K($%jYLcc7j9`VEdT3>G#o9EWii0k$u z?&zyrDQ%`^mk?kbyAGD#=Me{Uz11QM+8hAj>Wd#+Hvy$Vt=`8d326;YI|WO^Y8mnK zp=#?}>I&x6X|`fCg%~JpV_TGW-Obm!0HA9p>dh{b1m3G?50k(^{^-CC7cp;g6M<*d zLZ^4$Wv3Z?yJkFGA8gZT8Cbb1e98^8a2*_CutPq9@~!6PDZ%~{UZnci&%fP>&IQTx zun0*`k1S`s=JV7mqOzrZwxNEn%N9s zojYkkydI7-2Y?x+xNmyuEW#MvGd+^9Yz#Nx8;+WcxMD3HDOC3x*1#9xi=CLyt(TY$&zkjz2xUd2v z(c=zNh0!FP>bO3=Fw8Csn8ihV6sf$J3A;`-C(j6P9)Jud(bt3p62U}tLLxGW$z(>) zGeIqLTclBqz=ltodYukt*H(yIG`@~b=%5nXgvSxg&ehdbdSLg|acdfV=DaK6W65y< z*z~<-#j!oHhEQ4$7pxsLem6;XS7m&&(e#2U{EW#{p$fZ)>Iwx2R^R&=#BI^jKG%nl zslZrdvV~hXvND{sr8q({sfN7D`};PH8F(VIUIhYhs==UqE$pwTln%xD*6vDDJmKxy zr{CPPLqVtx=YCEw@_(Y%EXxT=5abv{nU4H!HswcqU%Xr>4-ov~eZiwExVcgC?$;5a zFT6`{(#EO37R}@x_3c9=1Sh$yxVbA+3>|^r6E(lhoRItF!(I};5%_3(y=QiGep$$h zpk~)SEh%vO&I1;_s_ie|{E01dWEv|2z+Rc{km1o+rw}b) zYqGe_k8GSM5L}D(;iKy7DgOFZb#?2Q*Z3fETX~#ZK_xXihQLG4FZJ~uh}yeWqo8Xp zS*N#jhy@D89seM2Wybhl)HXId?Dg6jD&Z=L+dJ?cW;mpiY?{Qp4HAT&B(^$k@S*pw z$U7k`LZKs_-I=)t8XMAzjPHjVFv{_|oZ_l|Ud(U`S3;g55LSCjxVFHr&;NB#D#S|$ z9m{8DF-?q%z<4LtCCd1Nhr6e-4|tQJI(&9+$B%9x!wzGB#tef** z8~IvRo7@3ns7DfYkutUtYLDXD&2mxXLJJA(_;~75WXv&ITh=}>w9+;|LQ4e;zN9^A zcE-gU!;32u0dbpMR!ygQ8as)Hm@AYrsqP3SvR-SS+&iP{88v|LG5#OJdkDqcqu7$a z9-y8PwXj=Ud070`uf4UeH?$@jP8}M*^0kY1Y=zP+ELgFI0kp{a}OuB+4a`UAC zMBHxsZ$eSj&JL5>W@oOnJoxyljIzR0K~TN7WxZZSdTE1=qL%kwcQJfWfj_|<^q2~Q zQF4r#6?8Tdb|36#)0Vap*m#jb1c9W9(K@u>+%T#(n4?y5`!VvBLkAZl=Kbm%3M1Q4 z5u0MWabewaJ8$%u8%uGPzO0ygw;2O~_cwVBvc5Hy4EZJ&MQ`{neS` zTbCyVT9Cm5Xv?##XiEOg+xZ0413D);>j*endEbw$Du=jb`J)u2tSj@vJdfX+dD>}& zdG&#%6RVdmAKKnz0-EII-5hh>wkxAegxWqNWW0(5My?|QaiIp~dE zt)V2=%&DoaV3A)HTPEK)Qz%OhA2e10(|x__J5hrchr@nS{8ewGC$;+&rM3pk_Jwv7 zprvc;`%Z*or7^?KGlAk>iiuS3T&K+w4DQ0EiMwzyT8-_(Yv+3Y6_zd>7gqPk3_fNi zLc7oLj5H_WfQtln%X!hfZTybb?aDgSH6MS*_a-H%LpAONB*(Cr&4iMTn~hiJh=uRK zo_k0!p~3_?9nc7;8s}28=>$}(U@T|9cyM@yKQlm(;(8R!ZhXuO0%}9z9wF(#{m%sw z*l-^8ivG_le^@`3*`v5(na^5t{wUyw-GLvyxNH%bP+r?y_0bSI_^J?^Q>!^vRG|uj zjzAsq#74q8m|<;bSvKu%mzJN4o;1*K=R0wT4s0rnaSX9iT5=ze(nsF9pqbRXRQalK z0xoHlQzUgTtedAicEm|cHqgjT+-fq^O&5#fF_lv?G6seiOdoBhH+VEb)7!tur>c$1 z+K2UQzpVuTq;m#8k&s_b)`%R)&-*uFkDfW|6oedSTDf`XhJq0&2}dn6UUSz?CVCsx zGvG5h4qk))cYN@7k`2=4?K99gRR?CCiAYB`^^O-quy=wdSw{^Q-qK7gOFu0ad#ZtD zmnipd)5-z#YcPzsW4c$A0`RquqUh8$ltY4?_QYE$LeQIqf|d}^X?Pq!{$!)cs=6fz zRPSK@n)J@9vqHUjsb42F|EprpjTW44^ik6mbXQI9t-Sn57Ht_F!cSXe#W*G;6F;CNMN*f;w_9NP|x%~-5qrBuEjH|3T! zO?9wb6$U)pPvZIu`Qn3yESG=TP3bZmr=w5f6)h{4TBT#L$^O*L@-(nyf7#K|KOp@t zBWs+1YROoLvXNes+Eem=L}vwhS6O#Q!;lsZ>7NL3TNPBsV1kRDi+^>B6d2khu3OQ7 z%Pj=QEu-8h6&`nPx5qRCdo{gzI5BPF?gfY&Z^K7dvm;%nrGlU^RQ(T$nbt*&RdU`; ziqHUL^MD&MV>$12PP$~M*?Mf3pQqk&aN;DqvCLclQ{o4{gZQK*qtbMg?r-F~tDmmA z+b?>)Eu6Su#+n~uoJ3H@W@C>e672*Lwu9h*C?1=Lbn+?0$wiwmE@ar5-?JocO|l~| zolYN1$`=T3dg14_OYWNvt%{5s$`~d*uS_vms~blmnCd!y_}?dh|5_!rLFNkFy0yctCF1z#_SA z#r35zJ|H!LdI)y<6o#|e0e_vSp46stp?Z)%Q!*(3M|0!4UJUFasE5^Lg@3==4(S|Hri(v__nLz zhn=SXR0|1^)cL%gG%$ux+}z< zD+9iIk8xkLPQt!~&xQLDf41-b`Yo(>`@$bR;;>B%~y^V_YLn`5v~l$nC*bQZF`RB0^nI!T)0x>P8z$u6A%x~HYxMZgwd|a4 zIIdSvqH9jg+?U=2s4k)%Hf9+0=yhiD515zq{-+_seXi%7ZyQ<&_2P=AI&E|Ic=55T Gzx^kVX6^<6 literal 0 HcmV?d00001 diff --git a/README.md b/README.md index e97a4de1..2225a132 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,46 @@ -# it-tools +![logo](.github/logo.png) -## Build Setup +Aggregated set of useful tools that every developer may need once in a while. Available [here](https://it-tools.tech). -```bash -# install dependencies -$ npm install +## Functionalities and roadmap +Please check the [issues](https://github.com/CorentinTh/it-tools/issues) to see if some feature listed to be implemented. -# serve with hot reload at localhost:3000 -$ npm run dev +You have an idea of a tool? Submit a [feature request](https://github.com/CorentinTh/it-tools/issues/new?assignees=corentinth&labels=&template=feature_request.md&title=)! -# build for production and launch server -$ npm run build -$ npm run start +## Project setup -# generate static project -$ npm run generate +Install dependencies by running the following command: +```shell +npm install ``` +Serve with hot reload at localhost:3000 +```shell +npm run dev +``` + +Build for production +```shell +npm run build +``` + +And to lint and fixe files, run: +```shell +npm run lint +``` For detailed explanation on how things work, check out [Nuxt.js docs](https://nuxtjs.org). +## Contribute +**Pull requests are welcome !** Feel free to contribute. + +### Add a tool +*Coming soon* + +## Credits +Coded with ❤️ by [Corentin Thomasset](//corentin-thomasset.fr). + +This project is continuously deployed using [vercel.com](https://vercel.com). + +## License +This project is under the [MIT license](LICENSE). + +