Skip to content

Commit

Permalink
preperify README but still lacking
Browse files Browse the repository at this point in the history
  • Loading branch information
suan authored and Suan-Aik Yeo committed Feb 10, 2012
1 parent 117dc2e commit ad37aa3
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions README.md
@@ -1,10 +1,17 @@
!nstant-markdown
!nstant-markdown-d
================
instant-markdown-d is a small Node.js server that enables instant compilation and previewing of Markup files. A plugin can easily be written for any text editor to interface with it. One currently exists for VIm: https://github.com/suan/vim-instant-markdown

API
---
| Action | HTTP Method | Request URL | Request Parameters |
Installation
------------
- `[sudo] gem install redcarpet pygments.rb`
- `[sudo] npm -g install instant-markdown-d`

REST API
--------
| Action | HTTP Method | Request URL | Request Body |
|---------------------|-------------|---------------------------|--------------------|
| Open (blank) Webpage| GET | http://localhost:\<port\> ||
| Refresh Markdown | PUT | http://localhost:\<port\> | contents=\<Markdown file contents\> (Multipart form data) |
| Refresh Markdown on page | PUT | http://localhost:\<port\> | \<New Markdown file contents\> |
| Close Webpage | DELETE | http://localhost:\<port\> | |

By default, `<port>` is 8090

0 comments on commit ad37aa3

Please sign in to comment.