diff --git a/README.md b/README.md index aec616b..4f11816 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,31 @@ # Quick notes The Quick notes application, is an application to take quick notes -Forgive the -redundancy :sweat_smile:- on small cards, organizedby colors -And in future -categories-. It allows a basic rich text as **Bold**, *italic*, and numbered or -bullet list, to improve the notes. +redundancy :sweat_smile:- on small cards, organizedby colors and tags. It allows +a basic rich text as **Bold**, *italic*, and numbered or bullet list to improve +the notes. Also it allows attaching files, and the notes can be shared as +read-only to other users. -![App screenshot](/doc/quicknotes-grid-view.png "App screenshot") +![Screenshot of Quick notes](/doc/quicknotes-grid-view.png "App screenshot") -## Instalation +## :rocket: Installation -Quick notes is available in the Nextcloud App Store and can be installed directly from your Nextcloud installation looking in the category Office. \ No newline at end of file +Quick notes is available in the Nextcloud App Store and can be installed +directly from your Nextcloud installation looking in the category Office. + +Nextcloud will notify you about possible updates. Please have a look at +CHANGELOG.md for details about changes. + +## :exclamation: Bugs + +Before reporting bugs: + +* Get the newest version of the Quick notes app +* Please consider also installing the [latest development version](https://github.com/matiasdelellis/quicknotes.git) +* [Check if they have already been reported](https://github.com/matiasdelellis/quicknotes/issues) + +## Building the app + +1. Clone this into your `apps` folder of your Nextcloud: `git clone https://github.com/matiasdelellis/quicknotes.git` +2. In a terminal, just run the command `make` to install the dependencies and build the aplication. +3. Enable the app through the app management of your Nextcloud. \ No newline at end of file