crappyrules/notehub
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

minor *.md improvement

Browse Source
This commit is contained in:
Christian Mueller
2014-01-26 11:38:15 +01:00
parent 24726c037e
commit 4f9f6d0a9c
2 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
API.md
+4 -4
View File
@@ -5,7 +5,7 @@
## Changelog ## Changelog
- **V1.2**: Theme & fonts can be specified at the creation. - **V1.2**: Theme & fonts can be specified during the publishing.
- **V1.1**: fields `publisher` and `title` in the response to the note retrieval. - **V1.1**: fields `publisher` and `title` in the response to the note retrieval.
- **V1.0**: initial release. - **V1.0**: initial release.
@@ -58,7 +58,7 @@ Hence, the status of the request can be evaluated by reading of the property `st
The note ID is a string, containing the date of publishing and a few first words of the note (usually the title), e.g.: `"2014 1 3 lorem-ipsum"`. This ID will be generated by NoteHub automatically. The note ID is a string, containing the date of publishing and a few first words of the note (usually the title), e.g.: `"2014 1 3 lorem-ipsum"`. This ID will be generated by NoteHub automatically.
## Note Creation ## Note Publishing
A note must be created by a `POST` request to the following URL: A note must be created by a `POST` request to the following URL:
@@ -115,7 +115,7 @@ Parameter | Explanation | Type
`note` | New text | **required** `note` | New text | **required**
`pid` | Publisher ID | **required** `pid` | Publisher ID | **required**
`signature` | Signature | **required** `signature` | Signature | **required**
`password` | MD5 hash of the plain password used for creation | **required** `password` | MD5 hash of the plain password used for publishing| **required**
`version` | Used API version | **required** `version` | Used API version | **required**
The Signature is the MD5 hash of the following string concatenation: The Signature is the MD5 hash of the following string concatenation:
@@ -136,4 +136,4 @@ Example:
} }
} }
The status object serves the same purpose as in the case of note retrieval and creation. The status object serves the same purpose as in the case of note retrieval and publishing.
LANDING.md
+1 -1
View File
@@ -13,7 +13,6 @@
Send your feedback and comments directly to [@gravitydenier](http://twitter.com/gravitydenier) or open an [issue](https://github.com/chmllr/NoteHub/issues) on GitHub. Send your feedback and comments directly to [@gravitydenier](http://twitter.com/gravitydenier) or open an [issue](https://github.com/chmllr/NoteHub/issues) on GitHub.
## Features ## Features
- **API**: Integrate the publishing functionality into your editor using the official [NoteHub API](/api).
- **Color Themes**: specify the color scheme by appending the corresponding parameter to the URL: - **Color Themes**: specify the color scheme by appending the corresponding parameter to the URL:
- [Dark](http://notehub.org/2012/6/16/how-notehub-is-built?theme=dark) - [Dark](http://notehub.org/2012/6/16/how-notehub-is-built?theme=dark)
- [Solarized-Dark](http://notehub.org/2012/6/16/how-notehub-is-built?theme=solarized-dark) - [Solarized-Dark](http://notehub.org/2012/6/16/how-notehub-is-built?theme=solarized-dark)
@@ -23,3 +22,4 @@ Send your feedback and comments directly to [@gravitydenier](http://twitter.com/
- **Editing**: if you set a password during publishing, you can edit your note any time later. - **Editing**: if you set a password during publishing, you can edit your note any time later.
- **Statistics**: a rudimentary statistics available (date of publishing & view counter). - **Statistics**: a rudimentary statistics available (date of publishing & view counter).
- **Export**: the original markdown content can be displayed in plain text format. - **Export**: the original markdown content can be displayed in plain text format.
- **API**: Integrate the publishing functionality into your editor using the official [NoteHub API](/api).