From 0cc93bb91358f74a032dbb0665f03a68230be9eb Mon Sep 17 00:00:00 2001 From: Niedermann IT-Dienstleistungen Date: Wed, 15 May 2019 20:55:23 +0200 Subject: Readme rework (#76) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Use ⚠️ in README.md * Use emojis for headlines * Use emojis in fastlane descriptions * Adjust access options --- README.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 7067aa129..d5ec0e99c 100644 --- a/README.md +++ b/README.md @@ -6,32 +6,38 @@ [![GitHub stars](https://img.shields.io/github/stars/stefan-niedermann/nextcloud-deck.svg)](https://github.com/stefan-niedermann/nextcloud-deck/stargazers) [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) -:warning: :warning: :warning: **This app is still under heavy development. Releases for Play Store and F-Droid will be published as soon as this app is usable productively** (see https://github.com/stefan-niedermann/nextcloud-deck/issues/35) :warning: :warning: :warning: +⚠️⚠️⚠️ **This app is still under heavy development. Releases for Play Store and F-Droid will be published as soon as this app is usable productively** (see https://github.com/stefan-niedermann/nextcloud-deck/issues/35) ⚠️⚠️⚠️ An Android client for [Nextcloud Deck App](https://github.com/nextcloud/deck/). -## :arrow_forward: Access +## ▶️ Access +[Get it on F-Droid](https://f-droid.org/repository/browse/?fdid=it.niedermann.nextcloud.deck) +[Donate with PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=W523CNHTD7ARQ&source=url) [![Donate using Liberapay](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/stefan-niedermann/donate) -## :eyes: Screenshots +## 👀 Screenshots | List View | Card View | | --- | --- | | ![Screenshot of list view](/fastlane/metadata/android/en-US/images/phoneScreenshots/1.png) | ![Screenshot of card](/fastlane/metadata/android/en-US/images/phoneScreenshots/2.png) | -## :rocket: Features +## 🚀 Features * Supports multiple accounts * Display boards, stacks and cards * Assign cards to users * Create, edit and delete boards * Create stacks -## :checkered_flag: Planned features +## 🏁 Planned features * Full [API](https://documenter.getpostman.com/view/4848351/RWMCtV4r) compatibility * Offline capabilities -## :family: Join the team +## 👪 Join the team * Test the app with different devices * Report issues in the [issue tracker](https://github.com/stefan-niedermann/nextcloud-deck/issues) * [Pick a good first issue](https://github.com/stefan-niedermann/nextcloud-deck/labels/good%20first%20issue) :notebook: @@ -39,12 +45,12 @@ An Android client for [Nextcloud Deck App](https://github.com/nextcloud/deck/). * Translate the app on [Transifex](https://www.transifex.com/nextcloud/nextcloud/android-deck/) * Send me a bottle of your favorite beer :beers: :wink: -## :link: Requirements +## 🔗 Requirements * [Nextcloud](https://nextcloud.com/) instance running * [Nextcloud Files](https://github.com/nextcloud/android) app installed (version 3.2.2 or later) * [Nextcloud Deck](https://github.com/nextcloud/deck) app enabled (version 0.6.1 or later) -## :notebook: License +## 📓 License All contributions to this repository are considered to be licensed under the [GNU GENERAL PUBLIC LICENSE 3+](/LICENSE). Contributors to the Deck Android app retain their copyright. Therefore we recommend to add following line to the header of a file, if you changed it substantially: -- cgit v1.2.3