From 3a45446a3424a32da994a499e6cba026e2882164 Mon Sep 17 00:00:00 2001 From: Maxime Date: Sun, 27 Aug 2017 15:46:46 +0200 Subject: [PATCH] Update readme --- README.md | 50 +++++++++++++++++++++++++++++++++------ readme/wallabag_logo.png | Bin 0 -> 6590 bytes 2 files changed, 43 insertions(+), 7 deletions(-) create mode 100644 readme/wallabag_logo.png diff --git a/README.md b/README.md index 51a90995..b3661e02 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,28 @@ -[![Build Status](https://travis-ci.org/wallabag/ios-app.svg?branch=master)](https://travis-ci.org/wallabag/ios-app) +# wallabag 2 official iOS [![Build Status](https://travis-ci.org/wallabag/ios-app.svg?branch=master)](https://travis-ci.org/wallabag/ios-app) -# wallabag 2 official iOS + + +wallabag is a self-hosted read-it-later app. +Unlike other services, wallabag is free and open source. +wallabag 2 official iOS is a companion app for [wallabag](https://www.wallabag.org). + +

+ + + +

+ +## About wallabag + +wallabag has been made for you to comfortably read and archive your articles. +You can download wallabag from wallabag.org and follow the instructions to install it on your own server. +Alternatively, you can directly sign up for [wallabag.it](https://wallabag.it) or [Framabag](https://framabag.org). + +This application allows you to put a link in your wallabag instance, letting you read your wallabag links offline. + +wallabag is a creation from Nicolas LÅ“uillet released under the MIT License (Expat License). + +## About wallabag 2 official iOS This is a self-learning project. @@ -10,9 +32,23 @@ You will find mistakes, many mistakes, do not blame me, learn me with a PR. You contribute to an excellent opensource project, and you will make me evolve in the Swift language -## Tools required to contribute -* SwiftLint -* Cocoapods +## Features +- Connect to your self-hosted wallabag instance or connect to your [wallabag.it](https://wallabag.it) or [Framabag](https://framabag.org) account. +- Supports wallabag 2.0 and higher. +- Completely ad-free. +- Switch between numerous themes. + + +## Screenshots +[](/fastlane/framed/iPhone6Plus-01Home-d41d8cd98f00b204e9800998ecf8427e_framed.png) +[](/fastlane/framed/iPhone6Plus-02Article-d41d8cd98f00b204e9800998ecf8427e_framed.png) + +## Contributing +wallabag app is a free and open source project developed by volunteers. Any contributions are welcome. Here are a few ways you can help: + * [Report bugs and make suggestions.](https://github.com/wallabag/ios-app/issues) + * Write some code. Please follow the code style used in the project to make a review process faster. + +## License -## Project installation -Clone the project and run `pod install` +This application is released under GNU GPLv3 (see [LICENSE](LICENSE)). +Some of the used libraries are released under different licenses. \ No newline at end of file diff --git a/readme/wallabag_logo.png b/readme/wallabag_logo.png new file mode 100644 index 0000000000000000000000000000000000000000..bbef166cab29c75e783c7835e7a8ab21b4d84fff GIT binary patch literal 6590 zcmb_>cQhQ#*T1!T2_Z%Ai`7B|(Ix8YH6&_Q5D_gb)+)Q?Q4%eyM+-KD=)LbIJVXzx zMct^;R*SxPeShco&-?H9yi?B1+;h*|J9o}}?mc&6O^tOK={V@f$jBHWdRpdWWB`f( zbQ-E_3OqCcc0Ew|J%(7)T$d1<7ctjsDyV_37TMK*>ZkVNWHK^#XNcA#%b@J-Ie49& zb`EaO+vYo3LnDCVdjkEZf|@2|YebWH!D5sWomf*`!jQC56CWLQ;*EkPz`OgzcLEzR zkyNHP^|Ul%x~h^X_4r zU$#^wu7@QXI{qWZxDwnQD+MicUq?zE6eaE$75HQ(d$bMM#Afq|YhkU_GXZlyB<|#~ z0$z#WK;R-&(aogx7@!W2%CSo?RV%!$rlcSsIC~ZP5IZ|q$JWF=RZ%nX`GAV>syo;M zvQ8@H5Gk=!7&(2fMmI|xQdctpI}&!f!P?lKsb*`&2}<4C#GH>_-3c<(_IzD0H*#Qr zUv&+Jfh1EcTdY4^z7MC~9eDMT78i!&Wto;Udu9+$@eBf*N*-FWfw+Tx>_C$La9T7} z%MDgwKBHS!pVd&J#&OiaQyt|ftjlX>+0gpv?UXT~x-f#zhPJI)cl#Wka3qJfMU3e{ zRQFx>DI-Dt;T;q1iZc_2Xez@GpQM?lz8Y)?%lMvVHhTKCj!7NnGnRTGgNuG(4|8$N zE^?T`b=(;F4z{B#>dO^-Rg~_?zu$&Ici7X{EuF3+Tu8NXQD1l%Y&xBFXk9{RrkdZr zAv?;?{%7jFzNn_$a~uaxR=R1oD^44f0^Fr_ijHtmc`PA5nk4N6{#p$17PslPK;2FG znKq95&eCUQ#8ws6vw`mWMf0%PiCu&&Q7m85BPO)tfzY*t!U2O~plCy@=F|SL2^NI2 zyWTao?l093OMV?Yez{qx%i&lzt6Cw4O|-oO#S9@mgzf9T}TnprdGQ}mhPdBb;Y z{0jS~deQP3Hl;cYBDas|V`LLYY08d;KkYrl%52h_w!*!F*JHyT8Mhz*4(z+i$O1b}U|- zaEeP?$zy?BY;F6CyoAZlX_vXAJa{{=tHNKrp^+jy2*@4F!Sj_!IcN^BRVwkp^p9C1 z&+siUa-s2ld7O!8cpKRJ8DN$?geU0r-9%gSc-5?o_>On4fD@oOHB(6BbB+}gslnt5 zvVe{KYW>pc$QXm_(nu@WIj!b?xDaDZ;rg(0)O!xkWFayK3KfmRZzUGNWI@j-6CBJv zxd0MHXP+KCeP-C)j}RIk$nOGKkAD;Od`70yEbjK$+;Qf;&4xLQx$omDur=U!h~9>C zZHd~+vQaqk`)Sfxafi;~qvDrJ#eZuBN_MjK55E6r7vLA!k8)E{d`SqNXu zhm$ZJzT)H5nKgK$&$;}E^^9My&ACbr_4O0kjA=GDKt^-8EAFv_Hz9*_RoqpwyYEXm z3y6Lu$G?5Js@H zLbR2_V{@5AkQ61aK*WSCD%3zUke6VDyNlfX5@zs`bG?#G3>qeiSdFPGeoK?2hV*!<|gm5ur4&$svK{Zm}1zldHrfA?==;oR5dfYnc} z!7CaBJ!mp65}CQYa}m#+o@))n0y}JVfa6yTHl?E@T}Se*EKIsNBYK>5%TJAGrET=L zCVX!1;o@$qdX}6;01Pf%ExO4kZV5R3Z~VisG@%xDr`dyes@^F6n$^K0?=-nvS z%)x+RatDV`c92lwpjKireu&xt>Fk$sE+#x5|D17mh-;-I0DUCoH74m!_8Bg5F&pPX zq@GPHm_?v~_tR7rw3`E6B`nMt+cN$l47YRhXIW)a5RaqY1P+=KlVwxBa?CjGOK>pb z?=R2Y*PM@UNeRqifCmmIS3~q59Z1)flLJGw)Q$2qZS}4vzpxKHscdI09=g{_(Kj4f7|B&lpBNa$8?R}Qu& zvbQWvY1KcU1nAvc6z-{kGZ0>yl&e0WcR zy-?_PH<7%;DgSr>;?`HVhz~8+=bKZbCWLX+t#&=dsD9KxhCEtCUsy3#& z90cxjq#^OHr|sX`8<9${WKqPoJ9Ge4$lGfB54Rr2v2N>c#mm+2o!ufxL66Qomw8F^ zSs7p~r%Y$NJEIKn@&=TOWUtt7vYCaW6Lt_20v9VVwMdxT5hf{MYjX z)r4UI^?kZovbO5!)v-}qWENZNQicogF@*gh>98lbg53B^o%Z3bmy`TvUhB@2X#sZ{ zuAvja#?68rn39hT%xF{DM39J_*UBzDItb8%86`*cEUbqFZa;?>ox0hCYana}gd)aL zyPE&_=T=mfqDHHllU~bqhEs$@{K;Yb=myB62s50mH}o^s*&T9{R4mWWRih7i*mFL? z%=&QcW_preZ0LkHr5Aul;wuW21yH#&mHbDJXrMxZ-g6S~F0#kK{0ddZ2Xw3yG@552 ze_3jXCyJ>-xXz=vc$l0BN=;89#zCV@Cfj5nx`i<)CZn>hZSTtEBft&jg! z|3jm~dGp|hJcxXP!Rer)F1QU#Mt%H6Ds_P8iK?VYEo>99x#+!?rAjwdwW0I3`3m4*1rxNC0zOgQ zj_~^<{O0CvQ7LEsK6}-Mdmw{NPRQ*bRT+pSup4P*g0P%Js{Q5jVVPUlaWL1Z{Sv0p znm5XbJD|@ogV@(*Y(#3QV{SrkHeu8bgG!lhT_m{zD@B8(K(JqKqL(gM_LDo+J67W; z5szmSBtp+p0E)qEp-l%Hcc=k79;@B0NvD+=Wy@sV;8g zdT;c8NMF3AxSJX2{S|X>B6(}!+nUx)wGRi`kkTI^@51-)!bFw(lY@eD`sQ^V_ zq@#X?wfSAHYj4>0ZBtg{i-*~}gZsOQb~do`b9in1R?IJ!pbuChAp6(^l{%#o_Audficwnmr*y z-SHDq8#hBgCJBz#j8XkzZ4p+*0U{sO%GF~ix?8doOh{Esyn5et)~#|_A$-(1t>!j| zHlL<>NZpi3q$o8bq=RQ_1bv=Ya+*9tXN@*p12Xl zzw3(*6d#02?uIT75!5Y~7mCbwT9NVeW9KwJ;N7srTK>ZUTjT*UD}yu%drR|zi6v`T z@+AflYqab|MSKk}Zw|-P?GH1FDG!PiF=T73&D{xJVOX@gqgrGeJMa7K`oMN0!QQ}x z;jk%lcmlN)Sp{FqRXZDj_@pJVY3v-ZtJduuGszUdFZ?>qx6N_b=J?mGtlDuy^`YRO zr4DmawD_sWsVy&c0vMO8Rrx}Bk;RK++}o}R-Sog-->zZah@wPM%iG&Q&;+Y|i zA!5bONF`We`>d;&wN;19v}*oW*KBP+U0NXzdlz!N*8w-6Gabv8HQlgxHRxM17_;}) zD0UA$7~{AE_E)nOl)SQk^q2UAxgD9>wSp&yZmnN-hwlhW9bEo8IaivYKVgySw(6S0 z_2LrESM&7$mL^Kt?2r={M8o|a!@fyVmPve!B-*k7JlvpUVRe!V*A7xZBc9p$Md#Vu zbo$-^YUy4MftN-Nm(}AvKh#_b=9Ctt7Mm&iKUfMbwY=nW4snIMM;FU$G7KE2qJ7nr(Tay&YqD^YUfl^^u8 zMM<~)9%b5#GB?`l;z@HtqvA%2rJph@lZGTq)db*PzuB=_*H}{BVHtU@PT7koux==t z3di$;=^1@&FLqGfjl2Jq5;C^2H?#B1WLr_(O%+Wwz*R$878#=)P<+#a_WcP*Zz5|e z#lu?}|D1OkygEQAQI~u!!=@U}J6MTSQdM|-^$X}<*fD+cpN%PnsLM7{c=k=&cC5i6 zHl58fk3OW-0H(*m=Pi^bT2ED`-PI|6gMZ@I^wNhhYh#fBS$o4RLw-o8Cp}aQ_1|V4 zuG1CfOrAC{;23Kq*$oP>fs+n~eNbH_!z=tsnegIR=gkEy-G!1TP>UGv`F=1~4|Zxt@0tJ}$4@ zUiE04(bU?=C`fV}d#XcQ>1qB+a&C3E`x?|48%EFzwwN}r&9#OSAu0(-{fDt_UaIRz z-;hBpoVTe&v!f8X251B>0Eh-ZWaHWH221#We9TY*s=z7UshlR+K(|7oViyu_KS+^F zw*}myE8|P>l=4xms(Gt4A$NHmLNImGbprd)`x0H#O?#qnwWuBdf;oLQ@Mez;b%yn0 zZe`}YNFc|RI;D*US5F@D6f~C4p%`)U{QMXXWSK^iY&k5`CWPUxEEA=^fMpV zKE`b;at8_JR~Yk7b>2_0cfn1k(&)G+h!5L$)U7n+VS8N4s0${u8xqvXmDj!qt{+T* zVP|_|WJ-y9yht~p<#X-F9Raqiju8_o)^0ER5r0VU=fD?onx|G&WmwRdsu>6WknS@$ z`Glx6{gi~Js@w9HrD*oP=poh4*ilOMO*WbvE$R2bRiIz*nnJSCyMf}UXkbJn_}H9sYnrD3j*)byPQ5E{S@Cq!btzW1GMucLOXP**P6yU2;F|%sjldnh<@+{W$EEBS@kGu1e{*CVcYyq<~cF%5i zAy3k9{sJ#mex|MM;le04I;esk8E{vMP?gPar`NPGNrw@Cg=)R@-^r0i7ba&^&Qn?ccjpfbAGY8`X2ND-~y6Uu)MwllKmuv3Pm zEVA9;55|}8ATpXXr-*vpya&I)8*HLSRi)MHOVqAAR2{iVf&6hr%U^H3EsPF8~JovNZ&cOaXL%AuLbUJsY$%$`CH zO^#elIH-Q?d#4CzyimNnKWyd6*q5$#QI1ddG!3SKCkpnTE5#SyxD9-wcg9zjC@BOv zTQNQ`$VhQ3U|L!Q_ief51lza}FQrFL4W@hfhe3A5N=0bzOxv{KN28$MKiRvHFx~GS z5NBHVqp<1NJ;xR~@O)$1-a(+N{||(8G86N0vI}kH_7wk4zd>1GK^C*g%ku+{MIuoP zy=o0>;rF3QPK*UT{jfXzgnOSSrI3V@jRT0g6Y4IWT$y!+6a?^koF9m@ha*Tsw>+D2 z_WY7^8QNO5>ve&S1r7++3)$cG;RZq5nq4W8ZPVUbT*mutm~a=8(1f;O2b5s!1e@`= zCm5#jjGH0EA6=u=Ecd(KIW`AsJ1Ak=qru)i$Fa)Hdoz9gqVVFKkn^!9Zx+NC$43+c)-1deN|2AGyAPn|YbLR99bKS_2t4vz zo$F0jv8)C_2PKK)gnQ(@YD9+0^ra&9zV@lQ;3~HMsH0I}bKtVoNDgC1@D>w$|C0Cky7ws!flYf9EGA^6qxR6u1VeO>C|aV|l-LNto}7j( zPAVmWF`P)FvtuJ=pRAO7gKI8w>ygmu;N+035XUJC$Ydw^!}!yACa`7(-N>ZC z702`^$A*3L;*-zySU3;^+v^>*I^bh7r&v=F^v<=}S?==dQfnrLqW8AHukSRr?>N-h ze{W~9$u91;k_rLp!@M?9>!_h3JJ+;7I$Iu6f)2|KhaxO>3_jX0o@kqTCk`Srab~@GB-pB}!pok%l+dA24JPZDXy9$4(Ld16>%ldjJ3c literal 0 HcmV?d00001