From 9e8a526cc20ba1a30ad0d14d2ecc095e25c2ba4d Mon Sep 17 00:00:00 2001 From: Skylar Ittner Date: Sat, 24 Nov 2018 16:19:05 -0700 Subject: [PATCH] Update README.md --- README.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f199398..e99148f 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,21 @@ NotePost ======== -Yet another notes app. Supports Markdown and color-coding. +A cloud-based notetaking app. + +Features +-------- + +* Markdown support for simple formatting +* Color-coding and favoriting of notes +* Implements the [Nextcloud Notes API](https://github.com/nextcloud/notes/wiki/API-0.2), allowing integration with apps that support Nextcloud Notes (like [this one](https://github.com/stefan-niedermann/nextcloud-notes)) +* Core notetaking functions work without JavaScript or in a text-only browser Setup Tips ---------- -* Run composer install (or composer.phar install) to install dependency libraries -* If you don't have any color in the navbar, run `git submodule init` and `git submodule update`. \ No newline at end of file +* Run `composer install` (or `composer.phar install`) to install dependency libraries +* Run `git submodule init` and `git submodule update` to install several other dependencies +* Install the database using `database.mwb` or `database.sql` +* Copy `settings.template.php` to `settings.php` and customize +* You'll also need to setup [AccountHub](https://source.netsyms.com/Business/AccountHub) \ No newline at end of file