nextcloud-notes-android/README.md

# Nextcloud Notes
An android client for [Nextcloud Notes App](https://github.com/nextcloud/notes/).

[![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)
[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

## :arrow_forward: Access

[<img src="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png"
      alt="Get it on Play Store"
      height="80">](https://play.google.com/store/apps/details?id=it.niedermann.owncloud.notes)
[<img src="https://f-droid.org/badge/get-it-on.png"
      alt="Get it on F-Droid"
      height="80">](https://f-droid.org/repository/browse/?fdid=it.niedermann.owncloud.notes)
[<img src="https://raw.githubusercontent.com/stefan-niedermann/paypal-donate-button/be5ad29a95ff890faee0b46d702b714b0a04aadc/paypal-donate-button.png"
      alt="Donate with PayPal"
      height="80">](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=K7HVLE6J7SXXA)
[![Donate using Liberapay](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/stefan-niedermann/donate)

## :eyes: Screenshots

| Navi | List View | Edit Mode |
| :--: | :--: | :--: |
| ![Screenshot of categories in sidebar](/fastlane/metadata/android/en-US/images/phoneScreenshots/5.png) | ![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) |

## :rocket: Features
* List, create, edit, share, search and delete notes
* Share text and links as new note into the app
* Mark notes as favorite
* Bulk delete
* In-note search ([#106](https://github.com/stefan-niedermann/nextcloud-notes/issues/106))
* Render MarkDown (using [RxMarkdown](https://github.com/yydcdut/RxMarkdown))
* Translated in many languages on [Transifex](https://www.transifex.com/nextcloud/nextcloud/android-notes/)
* Context based formatting ([#363](https://github.com/stefan-niedermann/nextcloud-notes/issues/363))

## :checkered_flag: Planned features
* Toggle checkboxes in view mode ([#451](https://github.com/stefan-niedermann/nextcloud-notes/issues/451))
* Trashbin ([#238](https://github.com/stefan-niedermann/nextcloud-notes/issues/238))

## :family: Join the team
* Test the app with different devices
* 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)
* 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

## :notebook: License
This project is licensed under the [GNU GENERAL PUBLIC LICENSE](/LICENSE).

## :twisted_rightwards_arrows: Alternatives
If you dislike this app and you are looking for alternatives: Have a look at [MyOwnNotes](https://github.com/aykit/MyOwnNotes).