harbour-nextcloudnotes/README.md

# Nextcloud notes client for SailfishOS

A mobile App providing access to [Nextcloud Notes](https://github.com/nextcloud/notes) on [Sailfish OS](https://sailfishos.org).  
Communication with the nextcloud server happens over the [Notes API 0.2](https://github.com/nextcloud/notes/wiki/API-0.2).  
The [Sailfish OS SDK](https://sailfishos.org/wiki/Application_SDK) is used to write and build this project.  
You can preview some screenshots [here](https://www.scharel.name/harbour/nextcloudnotes/).

## Current features

- Multiple Nextcloud accounts
- List all notes of an account
- Show the content of the notes
- Basic [Markdown](https://en.wikipedia.org/wiki/Markdown) rendering
- Edit the notes content
- Edit favorite property
- Edit category property

## Planned features

(The ordering represents the priority for the implementation)
- Login screen for the nextcloud account (using the [Login Flow](https://docs.nextcloud.com/server/14/developer_manual/client_apis/LoginFlow/index.html) if possible)
- Create new notes
- Delete notes
- Automatically push changes to the server while editing a note
- Better [Markdown](https://en.wikipedia.org/wiki/Markdown) rendering
- Search in notes
- Checklist support
- Offline support
- Overview of the supported markdown elements
- Usage of [Sailfish OS Secrets](https://sailfishos.org/wiki/Secrets_and_Crypto) to store the user credentials

## Features to be considered

- All features of the [Android App](https://github.com/stefan-niedermann/nextcloud-notes)
- Use user metadata and theming (via [OCS API](https://docs.nextcloud.com/server/14/developer_manual/client_apis/OCS/index.html))
- Share notes
- Import notes from textfiles
- Sync with the Sailfish OS build in notes app
- Versioning / trashbin
- Use [ETags](https://de.wikipedia.org/wiki/HTTP_ETag) to synchronize notes more efficient