nextcloud-notes-android/README.md

40 lines
1.7 KiB
Markdown
Raw Normal View History

2015-10-06 10:27:36 +03:00
# ownCloud Notes
2015-10-01 19:05:06 +03:00
An android client for OwnCloud Notes App.
:construction: **Warning:** This app is beta. This means it is not tested well (only by some VMs and my personal device).
2015-10-01 19:05:06 +03:00
## :rocket: Features
2015-10-01 19:35:16 +03:00
* List, Create, Edit, Share and Delete Notes
* Share Text and Links as new Note into the App
2015-10-01 19:05:06 +03:00
* Bulk Delete
2015-10-01 19:23:03 +03:00
* Render MarkDown (using [AndDown](https://github.com/commonsguy/cwac-anddown))
2015-10-01 19:12:01 +03:00
* English and German UI
2015-10-01 19:05:06 +03:00
## :checkered_flag: Planned Features
* Provide App on [F-Droid](https://f-droid.org/) App-Store ([#13](https://github.com/stefan-niedermann/OwnCloud-Notes/issues/13))
2015-10-06 10:27:36 +03:00
* Table Layout ([#8](https://github.com/stefan-niedermann/OwnCloud-Notes/issues/8))
* Simple widget for individual note ([#5](https://github.com/stefan-niedermann/OwnCloud-Notes/issues/5))
* Make a widget for all Notes ([#15](https://github.com/stefan-niedermann/OwnCloud-Notes/issues/15))
* Handle Internationalization ([#14](https://github.com/stefan-niedermann/OwnCloud-Notes/issues/14))
2015-10-01 19:12:01 +03:00
## :eyes: Screenshots
2015-10-01 19:12:01 +03:00
![Demo 1](/demo-1.png)
![Demo 2](/demo-2.png)
2015-10-01 19:05:06 +03:00
## :wrench: Contribution
2015-10-06 10:27:36 +03:00
* Test the App with different Devices
* Write issues in the [Issue-Tracker](https://github.com/stefan-niedermann/OwnCloud-Notes/issues)
* Provide Pull-Requests
* Translate this App
2015-10-06 10:27:36 +03:00
* Send me a bottle of your favorite beer :beers: :wink:
## :link: Requirements
2015-10-01 19:23:03 +03:00
* [OwnCloud](https://github.com/owncloud/) instance running
* [OwnCloud Notes](https://github.com/owncloud/notes) app enabled
## :notebook: License
2015-10-01 19:23:03 +03:00
This Project is licensed under the [GNU GENERAL PUBLIC LICENSE](/LICENSE).
2015-10-01 19:05:06 +03:00
## :twisted_rightwards_arrows: Alternatives
2015-10-01 19:35:16 +03:00
If you dislike this app and you are looking for alternatives: Have a look at [MyOwnNotes](https://github.com/aykit/MyOwnNotes).