diff --git a/README.md b/README.md index 4b7fab0..00026fe 100644 --- a/README.md +++ b/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:\ || -| Refresh Markdown | PUT | http://localhost:\ | contents=\ (Multipart form data) | +| Refresh Markdown on page | PUT | http://localhost:\ | \ | | Close Webpage | DELETE | http://localhost:\ | | + +By default, `` is 8090