Update README

Remove outdated info, add a few words about contributing.
This commit is contained in:
Dmitriy Bogdanov
2016-11-20 18:07:43 +04:00
parent f9fc80fa8f
commit e00a000129
+15 -14
View File
@@ -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 <jo.gaulupeau-at-gmail.com>
# wallabag - Android app
Android application to add post to wallabag <https://www.wallabag.org>
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).
<p align="center">
<a href="https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche">
<img alt="Get it on Google Play"
src="https://camo.githubusercontent.com/59c5c810fc8363f8488c3a36fc78f89990d13e99/68747470733a2f2f706c61792e676f6f676c652e636f6d2f696e746c2f656e5f75732f6261646765732f696d616765732f67656e657269632f656e5f62616467655f7765625f67656e657269632e706e67" height="80" />
@@ -14,16 +13,18 @@ This application is released under GPL. wallabag is released under the MIT licen
<img src="https://camo.githubusercontent.com/f9574a79e3fe61202392c44e55f0bdab261a9561/68747470733a2f2f662d64726f69642e6f72672f62616467652f6765742d69742d6f6e2e706e67"
alt="Get it on F-Droid" height="80">
</a>
</p>
## 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.