You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-22Lines changed: 21 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,37 +5,27 @@
5
5
-->
6
6
7
7
<!-- The following paragraph should be kept synchronized with the description in appinfo/info.xml -->
8
-
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.
9
-
10
-
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*).
8
+
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.
11
9
12
10

13
11
14
-
For further developer and user documentation please visit [the wiki](https://github.com/nextcloud/notes/wiki)
15
-
16
-
## :busts_in_silhouette: Maintainers
17
-
-[Hendrik Leppelsack](https://github.com/Henni)
18
-
-[Lukas Reschke](https://github.com/LukasReschke)
19
-
-[Kristof Hamann](https://github.com/korelstar)
20
-
21
-
## :link: Requirements
22
-
**Minimum PHP Version**
23
-
* PHP >= 5.6
24
12
25
-
**Minimum Nextcloud / ownCloud Version**
26
-
* Nextcloud >= 12.0
27
-
* ownCloud >= 9.1
13
+
## :rocket: Installation
14
+
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.
28
15
29
-
**Supported Browsers**
30
-
* latest 3 versions of Chrome, Firefox and Edge
31
-
* we *do not* officially support Internet Explorer and Safari (Patches are accepted though)
32
16
33
17
## :exclamation: Bugs
34
18
Before reporting bugs:
35
19
36
-
* check the requirements above
37
20
* get the newest version of the Notes app
38
-
*[check if they have already been reported](https://github.com/nextcloud/notes/issues?state=open)
21
+
* please consider also installing the [latest development version](https://github.com/nextcloud/notes/archive/master.zip)
22
+
*[check if they have already been reported](https://github.com/nextcloud/notes/issues)
23
+
24
+
25
+
## :busts_in_silhouette: Maintainers
26
+
-[Kristof Hamann](https://github.com/korelstar)
27
+
-[Hendrik Leppelsack](https://github.com/Henni)
28
+
-[Lukas Reschke](https://github.com/LukasReschke)
39
29
40
30
41
31
## :warning: Git (development version)
@@ -55,5 +45,14 @@ To update the Notes app use::
55
45
56
46
cd /var/www/nextcloud/apps/notes
57
47
git pull --rebase origin master
58
-
48
+
49
+
50
+
**Building JavaScript**
51
+
52
+
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).
53
+
54
+
55
+
**Third-party apps**
56
+
57
+
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).
Copy file name to clipboardExpand all lines: appinfo/info.xml
+3-8Lines changed: 3 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -5,19 +5,15 @@
5
5
<name>Notes</name>
6
6
<summary>Distraction-free notes and writing</summary>
7
7
<description>< 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.
8
+
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.
0 commit comments