Skip to content

Commit

Permalink
Showing 2 changed files with 24 additions and 30 deletions.
43 changes: 21 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -5,37 +5,27 @@
-->

<!-- The following paragraph should be kept synchronized with the description in appinfo/info.xml -->
The Notes app is a distraction free notes taking app for [Nextcloud](https://www.nextcloud.com/). It supports formatting using [Markdown](https://en.wikipedia.org/wiki/Markdown) syntax. Notes are saved as files in your Nextcloud, so you can view and edit them with every Nextcloud client. Furthermore, a separate [RESTful API](https://github.com/nextcloud/notes/wiki/API-0.2) allows for an easy integration into third-party apps (currently, there are notes apps for [Android](https://github.com/stefan-niedermann/nextcloud-notes) and [iOS](https://github.com/owncloud/notes-iOS-App) which allow convenient access to your Nextcloud notes). Further features include marking notes as favorites and future versions will provide categories for better organization.

Notes is available in the [Nextcloud App Store](https://apps.nextcloud.com/apps/notes) and can be installed directly from your Nextcloud installation (category *office*).
The Notes app is a distraction free notes taking app for [Nextcloud](https://www.nextcloud.com/). It provides categories for better organization and supports formatting using [Markdown](https://en.wikipedia.org/wiki/Markdown) syntax. Notes are saved as files in your Nextcloud, so you can view and edit them with every Nextcloud client. Furthermore, a separate [RESTful API](https://github.com/nextcloud/notes/wiki/API-0.2) allows for an easy integration into third-party apps (currently, there are notes apps for [Android](https://github.com/stefan-niedermann/nextcloud-notes) and [iOS](https://github.com/owncloud/notes-iOS-App) which allow convenient access to your Nextcloud notes). Further features include marking notes as favorites.

![Screenshot of Nextcloud Notes](https://raw.githubusercontent.com/nextcloud/screenshots/master/apps/Notes/notes.png)

For further developer and user documentation please visit [the wiki](https://github.com/nextcloud/notes/wiki)

## :busts_in_silhouette: Maintainers
- [Hendrik Leppelsack](https://github.com/Henni)
- [Lukas Reschke](https://github.com/LukasReschke)
- [Kristof Hamann](https://github.com/korelstar)

## :link: Requirements
**Minimum PHP Version**
* PHP >= 5.6

**Minimum Nextcloud / ownCloud Version**
* Nextcloud >= 12.0
* ownCloud >= 9.1
## :rocket: Installation
In your Nextcloud, simply navigate to »Apps«, choose the category »Office«, find the Notes app and enable it. Then open the Notes app from the app menu.

**Supported Browsers**
* latest 3 versions of Chrome, Firefox and Edge
* we *do not* officially support Internet Explorer and Safari (Patches are accepted though)

## :exclamation: Bugs
Before reporting bugs:

* check the requirements above
* get the newest version of the Notes app
* [check if they have already been reported](https://github.com/nextcloud/notes/issues?state=open)
* please consider also installing the [latest development version](https://github.com/nextcloud/notes/archive/master.zip)
* [check if they have already been reported](https://github.com/nextcloud/notes/issues)


## :busts_in_silhouette: Maintainers
- [Kristof Hamann](https://github.com/korelstar)
- [Hendrik Leppelsack](https://github.com/Henni)
- [Lukas Reschke](https://github.com/LukasReschke)


## :warning: Git (development version)
@@ -55,5 +45,14 @@ To update the Notes app use::

cd /var/www/nextcloud/apps/notes
git pull --rebase origin master



**Building JavaScript**

If you want to change some JavaScript code, you have to consolidate the files in a build. Please follow the instructions in the [JavaScript directory](js/README.md).


**Third-party apps**

The notes app provides a JSON-API for third-party apps. You can find the documentation in [the wiki](https://github.com/nextcloud/notes/wiki).

11 changes: 3 additions & 8 deletions appinfo/info.xml
Original file line number Diff line number Diff line change
@@ -5,19 +5,15 @@
<name>Notes</name>
<summary>Distraction-free notes and writing</summary>
<description><![CDATA[
The Notes app is a distraction free notes taking app. It supports formatting using [Markdown](https://en.wikipedia.org/wiki/Markdown) syntax. Notes are saved as files in your Nextcloud, so you can view and edit them with every Nextcloud client. Furthermore, a separate [RESTful API](https://github.com/nextcloud/notes/wiki/API-0.2) allows for an easy integration into third-party apps (currently, there are notes apps for [Android](https://github.com/stefan-niedermann/nextcloud-notes) and [iOS](https://github.com/owncloud/notes-iOS-App) which allow convenient access to your Nextcloud notes). Further features include marking notes as favorites and future versions will provide categories for better organization.
The Notes app is a distraction free notes taking app. It provides categories for better organization and supports formatting using [Markdown](https://en.wikipedia.org/wiki/Markdown) syntax. Notes are saved as files in your Nextcloud, so you can view and edit them with every Nextcloud client. Furthermore, a separate [RESTful API](https://github.com/nextcloud/notes/wiki/API-0.2) allows for an easy integration into third-party apps (currently, there are notes apps for [Android](https://github.com/stefan-niedermann/nextcloud-notes) and [iOS](https://github.com/owncloud/notes-iOS-App) which allow convenient access to your Nextcloud notes). Further features include marking notes as favorites.
]]></description>
<version>2.4.2</version>
<version>2.5.0</version>
<licence>agpl</licence>
<author>Bernhard Posselt</author>
<author>Hendrik Leppelsack</author>
<author>Jan-Christoph Borchardt</author>
<author>Kristof Hamann</author>
<namespace>Notes</namespace>
<documentation>
<user>https://github.com/nextcloud/notes/wiki</user>
<developer>https://github.com/nextcloud/notes/wiki</developer>
</documentation>
<category>office</category>
<category>organization</category>
<category>tools</category>
@@ -26,7 +22,6 @@ The Notes app is a distraction free notes taking app. It supports formatting usi
<repository type="git">https://github.com/nextcloud/notes.git</repository>
<screenshot small-thumbnail="https://raw.githubusercontent.com/nextcloud/screenshots/master/apps/Notes/notes-thumbnail.jpg">https://raw.githubusercontent.com/nextcloud/screenshots/master/apps/Notes/notes.png</screenshot>
<dependencies>
<owncloud min-version="9.1" max-version="10" />
<nextcloud min-version="12" max-version="15" />
<nextcloud min-version="13" max-version="15" />
</dependencies>
</info>

0 comments on commit 095c748

Please sign in to comment.