Permalink
Browse files

Update README.md

  • Loading branch information...
1 parent 3c4f05f commit 80502ca069b8fce5f9d410b58f7680ac1d5ebfff @knowlecules committed Jul 25, 2012
Showing with 16 additions and 0 deletions.
  1. +16 −0 README.md
View
16 README.md
@@ -8,6 +8,19 @@ Insprired by the amazing throughput of NodeJS but dissappointed by the overhead
See [rest-stress](https://github.com/knowlecules/rest-stress)
or [codeproject](http://www.codeproject.com/Articles/379614/NodeJS-REST-server-trials-to-validate-effective-sc) review
+
+## Installation and Usage
+
+Install rapid-rest with npm
+
+ npm install rapid-rest
+
+The following call should be placed on your web facing server page.
+```
+ require('rapid-rest')
+```
+
+
##Syntax
The syntax is wholesale copy of the node-rest project which seems to have lost some of it's steam plus some smatterings of other REST syntaxes that I've used along the way.
@@ -45,4 +58,7 @@ routes('/there/:where?here_name={here_name}&user={user}')
});
```
+##Future development
++ Allow integration with middleware such as connect or express
++ More tests

0 comments on commit 80502ca

Please sign in to comment.