nextcloud-notes-android/README.md

53 lines
3.5 KiB
Markdown
Raw Normal View History

# Nextcloud Notes
An android client for [Nextcloud Notes App](https://github.com/nextcloud/notes/).
2015-10-01 19:05:06 +03:00
[![Build Status](https://travis-ci.org/stefan-niedermann/nextcloud-notes.svg?branch=master)](https://travis-ci.org/stefan-niedermann/nextcloud-notes)
[![GitHub issues](https://img.shields.io/github/issues/stefan-niedermann/nextcloud-notes.svg)](https://github.com/stefan-niedermann/nextcloud-notes/issues)
[![GitHub stars](https://img.shields.io/github/stars/stefan-niedermann/nextcloud-notes.svg)](https://github.com/stefan-niedermann/nextcloud-notes/stargazers)
2018-04-13 01:24:20 +03:00
[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
2016-01-29 15:44:42 +03:00
## :arrow_forward: Access
[![Download from Google Play](http://www.android.com/images/brand/android_app_on_play_large.png)](https://play.google.com/store/apps/details?id=it.niedermann.owncloud.notes)
[![Nextcloud Notes App on fdroid.org](https://camo.githubusercontent.com/7df0eafa4433fa4919a56f87c3d99cf81b68d01c/68747470733a2f2f662d64726f69642e6f72672f77696b692f696d616765732f632f63342f462d44726f69642d627574746f6e5f617661696c61626c652d6f6e2e706e67)](https://f-droid.org/repository/browse/?fdid=it.niedermann.owncloud.notes)
[![Donate with PayPal](https://raw.githubusercontent.com/stefan-niedermann/paypal-donate-button/master/paypal-donate-button.png)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=K7HVLE6J7SXXA)
2018-04-24 00:06:03 +03:00
[![Donate using Liberapay](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/stefan-niedermann/donate)
## :eyes: Screenshots
2018-08-25 19:15:08 +03:00
2018-02-10 16:48:27 +03:00
![Screenshot of list view](/fastlane/metadata/android/en-US/images/phoneScreenshots/1.png)
![Screenshot of edit view](/fastlane/metadata/android/en-US/images/phoneScreenshots/2.png)
2016-01-29 15:44:42 +03:00
## :rocket: Features
2016-02-12 15:18:11 +03:00
* List, create, edit, share, search and delete notes
* Share text and links as new note into the app
* Mark notes as favorite
* Bulk delete
* Render MarkDown (using [RxMarkdown](https://github.com/yydcdut/RxMarkdown))
2018-08-25 19:15:08 +03:00
* Translated in many languages on [Transifex](https://www.transifex.com/nextcloud/nextcloud/android-notes/)
2015-10-01 19:05:06 +03:00
## :checkered_flag: Planned features
* In-note search ([#106](https://github.com/stefan-niedermann/nextcloud-notes/issues/106))
2018-08-25 19:15:08 +03:00
* Toggle checkboxes in view mode ([#451](https://github.com/stefan-niedermann/nextcloud-notes/issues/451))
* Context based formatting ([#363](https://github.com/stefan-niedermann/nextcloud-notes/issues/363))
* Trashbin ([#238](https://github.com/stefan-niedermann/nextcloud-notes/issues/238))
2015-10-01 19:12:01 +03:00
2018-08-25 19:15:08 +03:00
## :family: Join the team
* Test the app with different devices
2018-08-25 19:15:08 +03:00
* Report issues in the [issue tracker](https://github.com/stefan-niedermann/nextcloud-notes/issues)
* [Pick a good first issue](https://github.com/nextcloud/server/labels/good%20first%20issue) :notebook:
* Create a [Pull Request](https://opensource.guide/how-to-contribute/#opening-a-pull-request)
* Help translating this app on [Transifex](https://www.transifex.com/nextcloud/nextcloud/android-notes/) :flags:
* Buy this app on [Google Play Store](https://play.google.com/store/apps/details?id=it.niedermann.owncloud.notes)
2015-10-06 10:27:36 +03:00
* Send me a bottle of your favorite beer :beers: :wink:
## :link: Requirements
* [Nextcloud](https://nextcloud.com/) instance running
* [Nextcloud Notes](https://github.com/nextcloud/notes) app enabled
2015-10-01 19:23:03 +03:00
## :notebook: License
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).