From d85ad224f77630dd2a5cc48103e74f7080d2f0e7 Mon Sep 17 00:00:00 2001 From: Jannis Mattheis Date: Sat, 22 Dec 2018 19:20:11 +0100 Subject: [PATCH] Improve readme --- README.md | 37 ++++++++++++++++++++++++++++++++++--- download-badge.png | Bin 0 -> 10395 bytes 2 files changed, 34 insertions(+), 3 deletions(-) create mode 100644 download-badge.png diff --git a/README.md b/README.md index 6800478..59e453c 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,45 @@ -# Gotify Android [![Build Status][badge-travis]][travis] +# Gotify Android [![Build Status][travis-badge]][travis] [![FOSSA Status][fossa-badge]][fossa] [![latest release version][release-badge]][release] [![F-Droid][fdroid-badge]][fdroid] -![gotify gif](app.gif) + + +Gotify Android connects to [gotify/server](https://github.com/gotify/server) and shows push notifications on new messages. + +## Features + +* show push notifications on new messages +* view and delete messages + +## Installation + +Download the apk or get the app via F-Droid or Google Play. [Get it on Google Play][playstore] [Get it on F-Droid][fdroid] +[Get it on F-Droid][release] Google Play and the Google Play logo are trademarks of Google LLC. - [badge-travis]: https://travis-ci.org/gotify/android.svg?branch=master +## Building + +Execute the following command to build the apk. +```bash +$ ./gradlew build +``` + +## Versioning +We use [SemVer](http://semver.org/) for versioning. For the versions available, see the +[tags on this repository](https://github.com/gotify/android/tags). + +## License +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details + + [travis-badge]: https://travis-ci.org/gotify/android.svg?branch=master [travis]: https://travis-ci.org/gotify/android [playstore]: https://play.google.com/store/apps/details?id=com.github.gotify + [fdroid-badge]: https://img.shields.io/f-droid/v/com.github.gotify.svg [fdroid]: https://f-droid.org/de/packages/com.github.gotify/ + [fossa-badge]: https://app.fossa.io/api/projects/git%2Bgithub.com%2Fgotify%2Fandroid.svg?type=shield + [fossa]: https://app.fossa.io/projects/git%2Bgithub.com%2Fgotify%2Fandroid + [release-badge]: https://img.shields.io/github/release/gotify/android.svg + [release]: https://github.com/gotify/android/releases/latest diff --git a/download-badge.png b/download-badge.png new file mode 100644 index 0000000000000000000000000000000000000000..52977c357168e6ca3e237842cb289e1544b7f3f3 GIT binary patch literal 10395 zcmdUVhd1sdta`Cx>o-6#sF!9f+$F~z+!i(qK6jfx;Pm^7zx+fB@-g^y! zxP?%Zd8GAnbOq;Wh;%=0UF)g5LGnoJ`J-mRM}`^$_g#ZB2Rrs?xYYlZAFo7Za+aB%3dC)P(F+rJ8-BDmx3t8aK7G1Tg}tAZ z%2PvTd~pVW`1IaI);u`Frn4tmqMC)5H~*u_;@2pR(Re{SX4zQ_D!kkY{NlmcD2=7T z#l=NGyZDR?0Tk?#l6ArFYB-p~e(0P+JS5*6Fe?%lGi`iRLLz;>2)(tW7@xs&jY_R{ z4Ufl1L_{!K^(04g>EyTN8DM88YQ4;gbQinf%}Gi|xXI~-qAb712i4ctyAj6q{9nIr z86FF$(Ha1-l2z9nor%nmD zEvnN#c>d|X@0PXLL!LW#mcqKdtw(HLPpPFo4|?~6SAwwEn^x>Hr&Rf3g|3zcf%q9+ zP*8BV9$Oz}T#Lqs8egHN-lDf6545y8((w29pSTu&<9+Ph{Cr0Qo3i=$c)^J1XxSdv ziWjlb(QM}_8KV+}os_~DC16+6cNZl&)RH%U7MeCWS{>S}R<{1ZxRSF^p=$%MfV3x0;h3%Jfdu^BD3X@8Y&b2Vu#Q5th8K+4F+TjsrywadY_gXdhd&I30x z1j05Eme~C5TMR{@-u2+QQ&!dbBePFJkxDk}GdwoF6mKglD+N3VhL8V2ATp_k^Nk|w zk5-%_5)uq*e)ii7@wt@uOlvj#!6fL!R;W!CTXa6~CjM5Wt!*|ps;>g6_<=!8`}33j(u#_T2bgvP)&3uYIXWkgWe9v| zha%n02ob2cJiRhoB>ud$+a)qGG8UTA>QwgrFVh8-45H1RZxM*EsfM*^Bn6YCp=H27 zG}^s=>B_Y-v+dIs)gG%EJEstcz!JOR{3`{~8Z6rRhImE((yJaGJAtyzd5i97v}jo6 z83cj?4`-boW?Pl;eZGN2+Dov{oRsrel#T7J@p%N|W`u^4YT|>Z#D&UV2-xng-3>0N zKaT(VZ$l#`R-Ih}Bu&|DtKBUqOnQ1RRQ;=_Dkuf~=WY_|0~_tb7AVU_XIQH#uEw*( z?WwDO>d{MTKj+m63G___;<>JO+Kt6->7=_XlF83>Ub?o!2T!y+V-|(>gnhDC6?dsxJvAO$IhScL4_;hm zVnTh!$ji$Q=a^Wly?y)EWwwn<@yU}YC_QCc+dK8Af7bfB=tivORwatK%0aJo+?*`4 z(+NZ|rAYZ1PtVL)93Sox8!7OR_nDcQ`CLb|nE-xO8ogS(Gh4ZkJR^^M;Tx{8*D~d2 z{rhgN)f4te@!emq*Ozh%I^JHoVLn#wAYlFD)^##O;Lg`Glu@*#vNBa}cr&bo%OK~i zTMsRJl6e+-QesbzCQsZeOc<|UXYY*RxkvWaZYVc=A;m9QRquxD>EKVkfz5yZJQsQX z>s77+RyAJOsr&J%UxnYon4E@pMEn8r+WpU7GC$Z}>8o&l7HF+`a(rZQw7)gIw3IF8 zyF8R9;5;o;&D49k;WEW+7A863S?h;(mN4?}q@;^cB+?JAsPwy?7Zw%<^vNo9nlwH~Msq7X zJY2x4`{qc!pI@bvxu2gOG)!1?b93RVQxBqAnfwg(%WN(By^anKXNy`HbGEjMFc?g! z{fGt}AWLs=?|Q>|rna3)KPTNDX-WxJ1N>8K$a#o+E1mUyE}$n*s-lQP2K{)S-_&>n$1{w-r*ddU-;pn zH_j&6ci)Cq0__%x9c*otf3Y&k<}g-1$Z#^KgHqJh{cpU|HLzQOU&aU?|DPP~ya*tH zc3_CPuDE+utM?MVuOA<*y6V!tl78;t5&JYvPA~e#wQFs=YcnmtU7_?6=+cVnYO!&v zc38;IpSrXnE?>;8td{E*%7%?|dWAe+zHHlG86z*4SA}j#l@9D6LQDvW^Z*i;9R(EF z32j4(TjS;BEq26-uI=ntnV!l-o@_{+qetdn=ccA};-U_Lx1~S8~ z!2I?n_UDFbAKdFuy;h^VO9!j#nVgZE)!VI=3zD+A}ULKhOMS0(X3 zQeVIH@={Kd3vF&{npwb*<7&Nh`uh52e~*-`!%??)Cy9{@?`}`8tnfhl5D!8Lgig!k zBx-zod=~zdh)h=9iQ#ltGimu~R>OlJzA6I5c5@*SVINK8!3Jx5MAtA11> zw6C;gy0tVI;DcfAP83PYP)W$>vMe$3%gNI((+IxKqcJivB7|iV6hx{31Pj^@WPTgs z+@?$RB8cF&9e)<4HXlG2x=rrNblNefCj(lP9p99Ps5*9Q&7@X8wQ|V-Y&a%c<6wfD<3;2 z^v^$!1g(F3o!^s}lUo|vXy-`L+AT4xbdkm8H@rTtlbH;1b#dq_H8nEJ*F+#r%icb> zqo=1}eLeKUhy1c*y)mD3(buUOO1L_oY9%jAS(&4)0zc$nJJqlsgQ(jN2Ri^h7gyJk zCF!`hIPKLkUG8k3gKdgx$rtYKg5#Hr8CHl;GPU1mR+On2$xgL+ApjOUbwWugx%-K5 z=r~cMmsf{=r4ji2aaR2IP`GfG41@Xzb@ot=V#RTn6l>?)Dz{T^$| zgY~&i_sM#*7E;`fjys==dwy8LeVfk)R%mn;ZtUunD;o2h7x?OSnN2^KDDbn==u_U{ zHT;pZ@aohV`}~ortDxG8K%l~kUzwINtdT(xSF6-oQL27B$@1#0j z+_RYOzV%0VQk_sbK@HeKL0~81!U7r53MxsWNH%u%n2}`n-^&hg+uMOXjj>FMbUE`Q6f&}?BIIuMtEXY$>h5)d{kC+ULn%5h!jrVTi2 zAiV^~2hSbFscCP_2wH>B_4WP_X-ee&>FeoH=pCHL$`!Jml`+iz*0NQ9z+&}kU4PyT zc%p3QnQwwaQVdxI*T{zpP&!QBfBt>{?wxvaax(St5uhi1xjbh&q5kBU^eB#hKfk!7 zWH5yGp8W*ZXswsW)`ZuphzkF2Ts3wo`F>iDy->nnncc7(W_d6tRyscnjwsV$Vg7r< z%1|;m1G;1i%{Ue&GI%0WiAw>I9BM;J3*eUQE8j69)Gw!pWrmAH4MD#j$snC)r$5v1#qCdYbNuyZU***e(1*4 ztD4V_`os6%O9TRu(-M-14#_^>YO3*VmHX`cd^XS(Mh~N9`4VuGYfHYvI_`UdaL+%( zt;@p&!+9In`lCFf(S9&M0wXs(c53}EY)zAGxDH&MzW7s6kofB)94PmK=v zp}d5t=stk(In_zfWw@((4kAxjnD6lNcH8o);H8Tuy*ENt-1Cg8hq4*Yo;}+!Hdftt zbPI4}Z+BN~$xHI(pHGfSt2G;{p_^**%Us)xX3w6vj}=?>FeYT|tgSuO)6=VRKinU# zf06C3Bzs<^UrS$KKV8*^XkQ6#lRi5}Z&#Vsah>@frLsSLdWcmuaIDob_Nu9=8Hh#s z>do(`2`o$r46K;6MXH(10d!W)`TF|KsfxKTY2nuEPmWeyKme0s=Qi>E>p+v**2XPI zf0`)QCr^%tvug~nj(wR=(_AooNBjpy)h~z~sT}40`{z@}m%sjXSzhYLgds;jfU&W# zr1eb>0%&siY)phn9qVFi*d241-}$sm2sw^t8ZchIY|_8USM$gJ<;$14(HtBcov@na zP0>YAijhNk2Fv*g9o2d}z`Cr0f`i%PK)Z}Sn@^C3s%Zw1lE7J@Jb92afHw&qw)8I|6+sw~zy8w_e8Xb4Ej%JNw)Gq(iFDK|^kvoD z+={8!X0Lq9;2?5mauuu$7cQBoiePWtPMpWqKkcbW?#W;eQv(_AxK{OfU2=7GWxIR# z>6NQj*@T6$%@uc_eT&l50eR74E+C@CU*o-3?C9B_p_1b>@nKZwH|M>3n%ElHlQ~ro zi73#M*gN&;t!z`jd@hhWxxQYqA<04Z%Lm^=Xjy=t%l7v`G_anhxcL#2;;Zj*2vVQh zYx{RrpExkI*1TvI=p_N$f!jhaezcTCn9BB-l19hgDE&?4yG_7xy*^Jllw@UQW)|1a zDE?C2#lDw?}YShlZ4lH8>Q4C$R@D(F&ru0>kH2R{`>Ehn>V>z!2hOHYrQKGu;3O1m!`$pz-}x|5R= z(Yb))TRx!|jy~}_43}r@nomU7;duLas#EHt*xEs(RXH`lp_%c@=0X%23x`c!Gr$`%FjJl%^OMg}_8 zatju;D}vlUG@elWY@;9J;%wX*)gkRl2eF{-4o*u!UHxOz*``r(R(zXJ3-sm$fT*IP zVmOooE#Xmts>5h$FHb!rK1s$qA@stkpaV>hj&AABdK#LV?gb_cwHU8(Ci*E6=jk_7Oc`L|-eWKv^ir3}QdgmV`gx=Pa^w1G^K?Tf^t9jf zPAD1ZSfaew-a0a%7pgqLnJ6eI1PRnitD!B>UgTa|OBU`gx54~X-B2930d1>aYW+_j z1w({Qe@0NS@=B7;Gq+?bPp_4vq*@A=SYaavR8nGWEC?j-UJ3J17#Atm|p%mrH6Gi3jIwUI5TroTKDc~u=d0r3VpH}{8$}n0sb^* z4E;70GSnW)gRZ5ThqXO)R8&u=-;enFpT>Fh!9FP-gIN;EIE091knzrfCUKehMqcTARAp{%t{^8T zmoBA-zm)!-2B(zGYdxHwL`HXC!DGDf?IjCf@D~ZgzZzbrgF9be!A@!~TXlT@9t|hk zzO_6&2O896eO7VraHGcpFd;xEZ>$q)++r{rDOGJ+Qf~b4;myC=KdZ(I(fI`M+^>>vPCu*w+)M;Q)Id^QX$Ze(e!sEyOrb!TZa2H{pewo!&2PXOgo>`mTCoP9$`4Y$@$X@~iu^cM# ztn~-DRol%wj%g;=VZVOAgE;`Xlc|;wu=hW(sNC54dSVs?nsH0|-*#58JCT7*zWGrA;zHf7TfVv)$zG*sp<~&6k6c+h% zwfl06_dXuO)&XMUXydFnyhkazu@%}35}twOx_N7#mc?FE(C4YSx<#MA#fJ3`j>z2z z5UCy=_0oymp^Jf25h-@VYv7z=AX9A9&yK6+d}Zufofh6@ylMJ@QOG=1A?*;g1`alF|y?mWNcZ-fPn>WyRhh zgavCiKWVEBn|K*nS^NhtST4};9ZI=CxwOxpZxRl_#@`13+S{E8b8iLp*#^?)i$!OQ z{mqL3nPEipf8gCWK5iHk8d{e1p(&7ZIfjy6D7RyU%Vz==P7EO)Z!H=vzuIMYHHPvLygx? zzWqpX3-89yVvAscNCs50p!cDPk4cfP`R|`a0cr#IpG9f*xT?X71+Uj8??lZHch}ap z$DEcwcrE8)l?+V{Vrsp1^v|+Vh5H`uD`HfW?%?WFlSK6-l2vD0$J(?uMN){yQX+(y zQ0ACG+QF?;V9bN@;gq@i^Kpg&iBWsM`xPk73n1U z@{2*s@(#j-~}UnKl*!hR(RMs%q5T7=-;D78Yp_UziZ&4^F10*)u^TsHLjg?f zWe#K7=@}VILts*hl(0RZ45Jr7SWxHh^s7nnU?*U_cA1Q!u%KpZ$e@ZSNDCV~@ALB) zc1anP^QL_Kc)1CWdO7u$v@8qEy)6(4(lN3&@XZ?%TsgNnDlli@TR%oEw(=&ikfua2Dhb+_ zNgy>TunQICuT#@DqksHRZ^ECfh56mSaU<4c`45=JjfEZ^n4`=ccW3WgvGDP!sU!&H zjpJ*<6T%QgOItezH)>vx3J4$Ig$W>|)!^BBv@t?)M;L|Pq)aB`bt3rk{Ng1CdA-N4X&D_*fs;K+Y7ZCXaF+2tx ziQC_WCv#m6KwRMj7J7+M>Pir|o!W1JVFiA-Uv(~jem!bJL+_>=d#}lY#o-$S0}bg^ z6fo4%cx4G10Bo=$n#+L{MQtQ0f!s9t=t}ElVmpR_KYj zoA?LFu<__l(Kin~*UkM?&+J44BaD?|d$a+XiaXamXF`R44`q~=-VeMeEaxQ+*rc1c zAxJ6?a~u|$7}8!?`W;vK#~btCFZ#Lj)3_jAB(!yPZ$rEo0|3{4uSc8(lA$649ApOq zF0%?F5ESB;#sQu}7$rt|)yVfY`_;&ov)TsR(($<8RTp;n+b&utCVGS|~PKz!#eEC~}e zr7}(~F6HmZ5(f)SB_9fh?dH4U0&Xx2HXrh#>T<vUE*h$|UnDM55m{sFN2Us3Ds^8C+&u;9M$W1pySXU!A2s@vBY(Bu%iPBzfjK!jG=9z__IMm4OV%7 z3#G^K8rN8F2a{6v3 zh*{oz6}?6#Xmv551qCC^$e1K8P$oqGPn>4qsy$+1F+s7hvG3l&$VtBLXxl)> zC1E`Me|lVvXeb<=qxPGco^BK--T;Wn$+5$KHiWVLIL~n-4wuCE_f=KxN@@Pml!O)( z3?f7RzNQV0`S(7+ogepCmZuAjj*jquC;w%RxGJ~aVYm<=f;^N}SHCPlfj~UqPRez8 zZ(_|6pTS1$hbysC`+FZ?VB9Pk8Kt2}A}t0panV~X`SWXAThXsxA<&F)UEl#+Na+Kw zJT1G!eZBLPe`*rUALc&1v*$4uf_p0e@BhHej%!VyGx~w^bThYqDg)3SFW)g5WW@CH zvhphN)6`#SW(r?UTJOm5&oDG*>gnJmDhTaAQD1jbOT8M?~92KC<1>c2)7;-Ql zypM%EO;OZs@!{W#9~s2t$ENSg6$_;-HNcJ`vHpeU*(RAb@x{8_JrII$Jg=&(Y=^{F zWD>4C47`UZjQF?oN3YMd1h2ktbM4;Nd(u7h>*7`R#KHS{&Hj$y^Wh##@dEL`XM##q zg0abccncZ0Y@i7<`fic2h2F%i;CEqRDO}9=g8yE;0rLj~!=PliVU~>q3VjlPKWj7j zF;)0*T3Q;)q?L*HlFOKFOPJL$Aw)s!et^(Ze7L1K~cH zqEZ$W^Rz1Qz7{fyg*iwmiyG$hVu^c(jc5?U29+-9m=Sx%T$@oA<~}2t)3VJvGIT)- zXZ9Z;5VzUXd}|(U399thT@TlU$TdZeJLb$)4%IHRHNcAhr5~!(Cx|}*3XjgwYqJoS Os3@x{lmFPn|9=4HR3f