From 05ec624c2931bf15f67790b80c00eac508e41d9d Mon Sep 17 00:00:00 2001 From: Federico Terzi Date: Sun, 15 Sep 2019 19:35:05 +0200 Subject: [PATCH] Improve readme --- README.md | 27 ++++++++++++++++++++------- images/icongreensmall.png | Bin 0 -> 11596 bytes 2 files changed, 20 insertions(+), 7 deletions(-) create mode 100644 images/icongreensmall.png diff --git a/README.md b/README.md index ec07fce..02f0f1d 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,30 @@ + + # espanso -Cross-platform Text Expander written in Rust +> Cross-platform Text Expander written in Rust ![example](/images/example.gif) +##### What is a Text Expander? + +A text expander is a program that detects when you type +a specific **keyword** and replaces it with **something else**. +This is useful in many ways: +* Save a lot of typing, expanding common snippets and sentences. + + ### Features -* Works on Windows, MacOS and Linux -* Works with almost any program -* Works with Emojis +* Works on **Windows**, **macOS** and **Linux** +* Works with almost **any** program +* Works with **Emojis** 😄 +* **Date** expansion support +* **Custom scripts** support +* **Shell commands** support +* **App-specific** configurations * File based configuration -### What is a Text Expander? - ## Getting started @@ -23,4 +35,5 @@ Cross-platform Text Expander written in Rust ### License -espanso is licensed under the [GPL-3.0 license](/LICENSE). \ No newline at end of file +espanso was created by [Federico Terzi](http://federicoterzi.com) +and is licensed under the [GPL-3.0 license](/LICENSE). \ No newline at end of file diff --git a/images/icongreensmall.png b/images/icongreensmall.png new file mode 100644 index 0000000000000000000000000000000000000000..9bde0d24159582e4cc84a24a3c9cec2010040328 GIT binary patch literal 11596 zcmV-SEwj>zP)005u}1^@s6i_d2*000 zaB^>EX>4U6ba`-PAZ2)IW&i+q+O3*tb{o5Ph5us|83OtP3;8j()yM2|u~vJno`1RL9tSU)fBkzs2cMtc&%g2hh`+zQ z?>-+y-by^D*Pr#gj~~2WetyC7`~CU#eP`=^p7uUb_?-Cpmvm*lejnG~Cra`4et7@w z`ulq$|1zETPh9WQzEA%9-`NPpE}Sn#7f%Yw^SkLPi4mlp2G9B(Qi(s_390crrSN_1 z+~?(Q!TY@WEp~pq-%npd;e34`P=AZj`~6UUdp~_H6Tgfo{Jip)4=jZ0fBpAM?C#y| z-t(H>$dyP{_ny>`sXVVZa1zS&e68{@ehRPcd2}9)DK0X$$>!v-T<9SZ?Hh8~VT2pb z^Sr`hh&i5UJjb|VdfscvVvp-dO4cLXXe47hauL%aYl*kxXDs2lZhx+~LgUIiaAXXe zEbxs#9`3t0|2L1%iSAYDhTz*LR*WmErWuAZr{5e!Lc)E=v^?>B9`2XA@xLTCk-_qW zxiP`v=j#-+grBvQo;)XxD?U5_YK>s~eF8$nwF`p@i46Ekd50Rj#YjmI$3}hzBabP^ zNd`hGaR+zFO-hyIw5V(I9ShH~vBcNgKnsZ|sU{;ev$Tf%zvGj&cUHeKeli5 zyF?PxS1OjuiY4u5NCdLq9m?sHm>H-Gziy6L&~k?sj)onG{Jy2bc{?Wn&l zfKbjl+0y0e$KN^Ko$aPL;@rvp@vGVHinH%HFUc5${}3w3goxZ~F8X`+Ug4Tu3#U?7 zHhejErB$ znDu(TaGCh+PoA@nbFM9+6=y91;BDW9`o zRC*&($i;JF$A#}M;Q*ec&NIv5dvqhesl|FoTFbe&5LyKoZay4zdm*cpx}L-ykObIT zDWKsB6yYmYZU2v8X->NyyoDz=4K!Q=Rnh%vEtrNBk@20cF0^;-1a1OfebQWG;1NbW zqvQu6P<{P`*Q<5i7-)vFiDj!{f@`qYyw!!Ulu!3RD9 z^)5~t8}3R6ngUXWP`(_Sad&F-X_wJX{O3+<$m73!z7J4o!^(!ynE}9qT_@#abDU$1>68sZ zws|FBf!|xghDL+hp|n;dxhUd9qg>;h6sjRvcbX}220x$pcTy&%eG>4>tN8a-0^a}n zT<2}3GTZeQP>#^)OVyyj%2dHifGyFZ=e7q+@(W8+9$r{7VzRlygk##FMy;fINN~L! zIYGx!N6WB_fG;e9UVu|LDJpz%RSXw^8+(6_75izbbap3pm#kctlL(yOEu#RDKL zm0|^r_T6#JFs3h1JbvWQ&YrtdRc=C2U?J~mKln`zMdJ*`XQt(^)$0ovJpXdIi8pTa_A9sjlD+%L74 zZ>9Y$(6B-->H^ZiSmCpj{a9PC37#7Z zQVx+RqIV17mpDSjQIh4hehja1IrAN0F#$!4HgL+MJj&RISu{gNGWa#qIuahV8sFZX z=0rm*wLGdIwnr=tL`>mbhs?^gEqwjS6`|5#L-^KKkk=3G;z5O7RPX@x5t|5}w9?a} z5m9v1z$ZYEy~E@vo0)P&myRc_^f@O*+rV4My+^zhiVUEZG6MQQN?Z|`18|K~Xj;S% ze6;8GST69f!iKdZDM%WSdaDfP8XE9sxNXB*;6i&3Z7i0=7#W|#<*5X7s3MwX`yvc7qm6$r^#?Y z_oz3>DxK00vN=(iIE5GxjcCPI4J~sm)>(!whnax~`rL(AqbGBzBNkqr4C(v<**3y$ zX|9+@z(OI!%j!t*L5}564z{WvhzR3X(MqRckzj5>{uPZR@G3GewD*3Zl+a};e$EpQ z;Cn^lsPntlON@?1_WR$76bTNfgO`*Y^#b8-Gz}sjX?`zrm5bAoh9@Xb(8x!Tt($NR zFrpISsEWX|vB)^NU5uYho{W(@lds@)x+0aKBe_JR8&LLVq;Qsk)yu>vJcC_`e+7mE zFR@LRQ^&M{)a}rh9pe*e9|#gnPtgmV%L|=V@&UPu&jkX(DBu@?jYZ&E0O%1U;9!Q^ zw4yX7l0(d^f(8AFgR~A!OVRb5(K%Kox)MK;0U{a6Od}p_2wg`DJA8wmxl`;Ic={DX zuE8(BF`}rsz+C8P_`OSJ(x?PRL`C19OHV;F3I(R7U#*svFHHv`F+RdZfID`wP^2y5 z9|B$iT`_I127VDB6QU1zE#aj*{63(PE8=Go38kDp2Aa!koIi+!K*#+oDut#{Qcl4* z*9KUk+EZ}5zmtR;#dVm1hi+Uqp{K?FnJGa}Fu#Zj0_dITv_1Mvq-hH#azApHPDrt^qgVh42GMN#Jl{G!?!DF+k0vj(ld z1@v}b(1=m5KZIF0E|sHoHKU|)!n@JX4SGW(7X;@{;H@NIkHDT^FZPh2riw8PTfS{c zn>*<&2<|-2`lE*H@68J!+KKqzH2_9RiAye8y{5;7pY1|~?{D-KKTP`5g{23T41`3v zL4-R4i5Y67MDaxRP&eQ~=>?w#zav?&Shypky*CxC^wrL++LKr~(u;9TMpb)c?ZV(HuZc z#w%+XC*uQ=70@&mE7=|`Z>EH}!#rcxQNXC86X8+t5Lx4?&jxN6y#C^&O7jCz7^LOl zYG6V9O=-z)bgnTHost}+1Furm_H^zidu66fY|go7HFkvqd1w(4Um0f%*25@*n1|eCoD&KQBwVa#(-EoPz{L*Z85W| zmA*|~EV{CTAjp|W+ti0^^IZ_ge1sBWw4^_{412fW=cgz!=qk$bDN23tD$0@GMfrT_ z)Shrt*(+h(yp{+LUhcpoL5pS-cBT;rVxo}S&j;TB_=o}Up@Tm-2dW5)_sD4^cX`DR zA(a1I<(T^nifLiKTgM8}K!NU;7a@kw3cZGbAxr5I4p~cMkL!>OkiL6E&^JOO6p08F zM)nB@)Izoi4&t!eGG3<#YzM}ik`iZ#EwDO;(k^%odJFf9^}yMHkbBw;En^cx^f?E~ zIutnlm|;1tPx0-G`P7=yk`tg^scSq5ppCBYEi?KMETXE3#Pm=~g86dWoHLQm*<5IHT**k;nQ!NR%I#07A`v_Ga(xdch^0N5Nn z^<53^k_Zf#jl}A;GR?e^4ol`QJc|fvAwVH8GPYDb+RWO*(m`!vMR51;mC&pw_f_z{ zo^g){bVJi(Z4+Wd>j|J|rqEM81R`r&8oPzMz*&rF%cs>$dwOy6h=#-j*b|4q!&CwTWH52YUjZNICMsYpmK-uN8{=~ zC?UZWjTkI~UZ)lz-YfFGwO`Pc9C|Di!dfMIsgE3)6`xc2WA3v?`?NW(A5oP+ZuAKa73%SlnER#Z zlqCYcrLo%5f*Z(I6HpR$mj-^4B0~)HTv2x(UBl&5vXHd>RkghlXk2T26<_FInKD~3 z7~feSig?Erck!@((DK15VEvHY(>iRU|MPj4=NT8r%xAHfI?_Vl zD&dE7!eI6Mm?s8|SkJ($m}`q(QQg;2n+2r6DMWDPPAzsGm$k(HC|U$yh1qZ(%S*9i z%%otbPk1i!McRjQMaq(2E$=MK?iFkdHxBYoXH--=^gI&i&d||)s4=WRg)}|hEF+4j zNg4tvNnkd5%cYaBB-GEg7P29;LF*)V3wKMCDG*tTq{_NE{fYFG_;4 zHT$6jJ0z8kJJdj-#PQ%uD_tt_^BOD^i2njEu>FVP#}$G!DKU~2+!{d}hf({z2%e;+ zCTn;}5DHi>+7Ez>waA}yCO``S>pqLWY2a4tv*?XrAHiO$-crz7^`<`-UTCwIvFproc4P7 zrtaf0iS=D^Kj+($psi<}U3*^?5O9*EA)`NVSai?EY)qI6(_SK<(jwX?4DvtNz_XHX zS}!fn8Xd(xC}%p!lxo9gQLcw_rh54Pn{ zce12=Y&uMe_@>sYLy=Q2L#qqaca(>x z{6o|RgId@$TDoFri)=n9a`z;`$gXmp1t6+YORVXoVL8t%KNa`cv~C(lNxqmbFgs9D zt@{bJU1Sa71Jj^Q4w&ym_aJ|gJHj()uPzT@9G|R{PYO$$6pRT9L9!gdy>7B^V*EbXN#R%Y4zpKV6$<6ou9d zPo-M?KyM)+FI=qkY{-0TSy=-^J#C@i)S?_{N8jsyfvNUHptK4!<5HMR)y{`jHv!sH zivuihOov{j8$T-%_U&>a276Vk(Zq8O8=N8y%Asrd$MH8J`fAk!tVP1-7yk_qy6@+{ zkEL~M27xj#7*mm3_!A5deg$8Ei^PjmK?mS4bSHso2Veez+=N3(+5BcUu}POdq5xj{ zy%zGW-C>k>BWVm`B4N>rsRJtzxS?wi->4Z>e!$n#-$WNSAR8|~0LiN>ji@>0vmhbm z3}A7TYeLm?4n|f)Z>C*iSY0b@L%tr_y#1;qB=`DQF;F%p7-8Rl~YJ2&Ud}n2XvjKwJ5WHySuAiVKY|4ooukKeQ`JCW?>|$N*8s zfD1IxxM7G;Kj`cdPz0n7&xIX9IjMR90$Ls+aS1yLN8)dkrNyht%YuCnM%%ZzRhu1DH^yJX_AngV&8#B=AS>c@`=x53Zn}urZ zb-===t*!nc>8~8^w9=ZjbfWu1fCepBdHT{2mz8R}9v$qT>YTbiM8ca9v>RmS02lmJ zpAcjR=AVtr=wpykrmMytsQ^UOEC{9*1x*0<#ynSG=DnT}3W$-v+41|^GurR(OoZFV zw4CI0iwi$hs|2$b-2eu{=}yOs((77INN9)F9)XB4)SC1KuH>d;kYLQu%BYEefjp$l z06xcUI5q4m3W<|M#LYEr$Dz9K4TtKCYwBJUa)T8{*Hf(K5$r{Zht5vVF4EG?i`km%N?1Hg)C0!@o<&_ooys*K)Ph)aO#E?h%(cLMNp-O{uTgj9L%p3$nn z>+Tsd-K?X#XIk|XMxP1IzwlhhAT-^iU@A52s&Ck5KhUng{w~suXc?SO%US}7b!tuE zYRBDcV-$&SW9rJ`F7w`D&#D^*`QEepc`S|{Jd+51)`;n4{B+k+04$!Y6RTEvIr@XT zS?lF+e?U@o-32z9QCPX@Pi;Fx{q)8;xb?9hIpRX&Y7Zcyzq)P(d&XUXmq?7Bo0vE_ zr&qk^G4yF7-gu9o8>6VB=e~)9C5w0lEoR~pmvVuap~kcB8jF%<;Wm%7%IfrF+OsAh zJ|O|M*obgUXje@3n?duL|ME^2zKE_Oc>fJdRg#xie7OYx000JJOGiWi{{a60|De66 zlK=n!32;bRa{vG?BLDy{BLR4&KXw2B00(qQO+^Re2@eqxAXf<}_W%GCen~_@RCwC$ zoq3d0)t$#bue!Rb7pgaUp_`>y8$pmAMdN~qmTQ7R+zn`4;*`snnd6L^Gn&as+>J{U zk4s`ECa&WS(osYa5Jf;X1!U`nrh(qOs=K=OH-Efm3^6v{RrRXwdwsv>)H$33)O+{d zPyO!i-uwIgE=Wm9Nl8gbNl8gbNl8gbNlB$ZitK`aP))T9C;=*fQ9!x==Te{u7@&Xt znL71PE6@lu0Ed7*`k$L{dwjB!C4k?+Rsc){rs<#Kb=dNOtRz1z0CeaeZUZ&~8-T62 zJ?#=e>%*o1xxg&oOyCE=1i%Gkr0K1qfKLZ_UzF|6e3jl}YtVf0P#mX;md-h8J69X?3xDmJ;D3)yXNzK47fv0eL!VaCHMl)%C4d@u3h-0lVYJ8;DdXh> z?f`zD?jt>0n&EQ-4*|cE@TF8P;7Q;ieGK}c1+1yg1D=)sUfTV_SApwsd%XPzz?$kZ z;3c#z7OC{>Bj7UJo+H)=P+RFPK?{MG5=R?=3sSv8wxt-p5x_DDpOBgcETg7+xHTS0I2zVOQq#A)pUG*Dttm)3gB}AFG~1KHyyvIkDZAD)PhHU zk9Hm@WiHJIp4G?DgaB$M9KS)^=aVw0E&+a{kEMxxKrNhVA@B@fm*Z$^MS$yxsed#g zoXZ#sXj5jQMYTxy%r86exIU&Puz=c%_hX<+j-93SHE>$8SH`v^!-v0hBohFw~KQ%kIEt|L&N?!XcW%0qR434tIOm7wlqv z*iTz5X69}4VHkAZCvP~wnnQcIfA8n440f5J%R<2ExILey9zd-wUkxzF?BEqEHf}B+&J`o4 zGA6$io08rXm5xw1ukP8%-3PYNpbGCRegL@Rty7rDPuz_KqFffaO1Y(K7Lx`JPCIzt zDBqFIb>mK9O7T$s&ARIt!>-zqP=0vw}CuX6J!XGdZ_%0@)dv!oFvH zS39?De3#e#Z6bH)dbGX4K3lNYI=_Smt4=0U+#LQBbv6u~g0+3W+c8-|@GM2)`H?fZ zX6#8gZ04e~F)=`t9K3xvFX=877DC8;va}V`1SCVJ92lYGVMbsm|@|m#16* zRy36B$DLw&%Xid(DGC=39w%}&r>k{Vl5PR#07K0(Q0HX1xO2jp!f&(0qvMMQGe+EY z4WkdIW4!}#S+#y=Btf&G<7C#nu8U|RPGm|6$6$;R9Co+W|9C`wi ziicoTDJV=W6#6d4b5VL%aJ08m@L6cLhzqZ?vs_$0YMLZ4q?&R&dEj-z&}VFJ zuII;}zRFMQzBmfLZ>-{@ul-!ZAcnEm^x8e>VzezO2r zOb>AcJpnif5c*K{jM5P(1|3m<(VW--Pq8~0Ut~P<`r`Mo zuFWfB{>Ui?y<31k9Q+ECsXQJ4g^qZfnO|mD;6X!Y8?|w+U>CYdxNq_~49GO*BJ!nm zU$W9%CER*ssizSXy5QvG0^@!kdwnfL`dBcsSg~#V-g1s`8#;H?h8z) z(s%$Y616opU{s!Q5yAUATYLR)^AsD`6;!Zj)O3z7sxWL%G8~KYyX|XOFK+l1@vzhr zfG$y6Q_hn$G=yAxmhmem5g9^MHQp-OAL+wQ_+qDf8D$flgbqjfH}ef z=*VWE)0o%mjz*{t_>Oj9GBPv^TQ8rJfI453n@gC9JCSQ#Hf`;1Lm9q5z^) zUQ6H-+| z2KrV54N4^H$J(p2)MpC_uvN6y_)zg1XaOs7@+q{?y&?i=b5DPHte*Z{wAT1lm2lWN z086r6Ozj6Xrc7iH@Z>XCMP5XJKb`!7p+pGlO zCfuIxM5bVXm7=w3o!8hyn(T~B?ie{e>EHYCkcrIwJNN(`whW5125`>M@%(Ald|nwn zi!$qM1s#)}-T?T4Xnx?9fX`4r5a9H|W4JAezTnUD%lS#wi9IG$<=7p}A2pSwlh0#{ z;OE`F^#49c27p_EdXZYTBN}GEx7pBVIBa(AoG_d7vJ%ffp6$%#zfPD#ZZE>f6kuA( zFrJ<`m*M8Ng!S}d8}HZvx;+tKxoE9h-+aLEXO!pUv3TkQ%+D!|`#XN%$l>Y9=TVW< zx2yK1msWD$h#8pp#=GS@I|*ArfVV)bllEoJwFFWSZ8F?d#8WeW!~^By`kX*>L;fIM zoH38l1@V>Hxp4RioS&U4qbQu0oyU^nPUF$(7cpc&{5i}y_Drs*IL?d!9tJ+_%|Gnjk6KkbQIsXX z^`f*ef=bQ7?MxV0ZdjGnzgLE$FutgqaYcjhgn~5qTB+~uz#9q>jYV-}WK!hJVQ_8% z!(2r;lH|WlC@jYYW{aR+f~xi^o4)rWS5tjvZ&o#_)UXUYpU%3B@?29+Q@zpwe+N@n zzd*COa)jsL_N++e6b$eQuv4T~?vF-zXa819hk<5iWRhd9%eQyxtdLv)wUCc8YbXB$$&=((Q4uM)9<052g}zHogk!gIUU8Gk)$n&b-y=rGUp>(d#*7ywnZ4tQI% zRzJ|Rhfj}KGliwy--*{eKdyIlMhpV*+*<%1MX;kezp8Tgj@4$mKdsl=)OOG;K5iIz zRA05xp@R*2U6U07`gmX+f?nyM0CyG- z=Z^8G8FsH+GSw33;{L5Gc(BzpSF!qm8Mr-hUtX7J0_;~nwWz(L0{1o7a_MKUv9e(o zQ9(C!RaDkD?dRHcZPXXIfze z!}E$M%*rJ%GwY}n%HApzi_#em(h}(6fUkuOZ4G?Veu%gI9mLEZJXWtyy-A6XPp%_W zQ#}uO6)<%=mjaBlJDKXpr7XwAh^#yYI|qjdM zvOd(!zNqC2kVk<_aC_cJ+K)fUFZdR)7`WBUy{rOXMS^@434*^BslRD4y-YSrj|J4M zU>@*3FjJ0~rL+#1i`(NB8$b=hvB1ala8Q3Zqs`Jq{sprb^ z61Kx@zyXnTZG;=*@%s^Ckl1^m_$=AlK-$mv+TY4_4(Z#0Wz0l&3` zUf>cPLb*B?W3~G-+8J-kQ}EJrC6L?G30#e~O%s(2q)kzM46fG4B;`tPSa3~s2H*ki z1F|F!DOCWt6IhJflQtue{=d zwf+g&!XS->+dfJgg>rvN_(&IKI(47?y(0Kvn+8j<}x zYXW#Qh!cUEfy;nAi-YGyD~+)j*k)GntOMZRrsiq|g+XYc|BHYLSZDht3T#6=u6zZR z!<_4}L?n@7NgJUBIh=%6Ea?JZmYsn6F8$L6Gyz9|LukPOEkL)?dA3qgQc_YGv;Vn_R~rSAU#0000< KMNUMnLSTXr4gyC2 literal 0 HcmV?d00001