From 4f9f6d0a9cd39d5768a3f9b334708c3213d3c161 Mon Sep 17 00:00:00 2001 From: Christian Mueller Date: Sun, 26 Jan 2014 11:38:15 +0100 Subject: [PATCH] minor *.md improvement --- API.md | 8 ++++---- LANDING.md | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/API.md b/API.md index 3c069d0..61ff871 100644 --- a/API.md +++ b/API.md @@ -5,7 +5,7 @@ ## 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.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. -## Note Creation +## Note Publishing A note must be created by a `POST` request to the following URL: @@ -115,7 +115,7 @@ Parameter | Explanation | Type `note` | New text | **required** `pid` | Publisher ID | **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** 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. diff --git a/LANDING.md b/LANDING.md index f5a9476..2a59e69 100644 --- a/LANDING.md +++ b/LANDING.md @@ -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. ## 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: - [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) @@ -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. - **Statistics**: a rudimentary statistics available (date of publishing & view counter). - **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).