From e00a000129c0ef203fc3bb18232e05370b8f85e2 Mon Sep 17 00:00:00 2001 From: Dmitriy Bogdanov Date: Sun, 20 Nov 2016 18:07:13 +0400 Subject: [PATCH] Update README Remove outdated info, add a few words about contributing. --- README.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index e284191b..fdc6a065 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,10 @@ -# wallabag - Android App [![Build Status](https://travis-ci.org/wallabag/android-app.svg?branch=dev)](https://travis-ci.org/wallabag/android-app) +[![Build Status](https://travis-ci.org/wallabag/android-app.svg?branch=master)](https://travis-ci.org/wallabag/android-app) -wallabag app for Android, originally written by Jonathan GAULUPEAU +# wallabag - Android app -Android application to add post to wallabag - -This application is released under GPL. wallabag is released under the MIT licence. +wallabag app for Android is a companion app for [wallabag](https://www.wallabag.org). +

Get it on Google Play @@ -14,16 +13,18 @@ This application is released under GPL. wallabag is released under the MIT licen Get it on F-Droid +

-## First setup +## Contributing -Say you have an account named "gdr" on "framabag.org" instance. The steps are as following: +wallabag app as a free and open source project developed by volunteers. Any contributions are welcome. Here's a few ways you can help: + * [Report bugs and make suggestions.](https://github.com/wallabag/android-app/issues) + * Translate the app. + * Write some code. Please follow the code style used in the project to make a review process faster. -* In a web browser, log in -* Go to the Config tab -* Under "Feeds", click "Generate token" -* On your phone, open Wallabag and go to Settings -* URL: https://www.framabag.org/u/gdr -* User ID: 1 (you will find this in the generated feed URL) -* Token: you will find the token under Feeds in Config. + +## License + +This application is released under GNU GPLv3 (see [LICENSE](LICENSE)). +Some of the used libraries are released under different licenses.