Update Readme.md

Mention options object is the second param
koajs · Dec 21, 2014 · e47bdbc · e47bdbc
1 parent 40c3192
commit e47bdbc
Showing 1 changed file with 12 additions and 1 deletion.
diff --git a/Readme.md b/Readme.md
@@ -16,7 +16,18 @@
 $ npm install koa-static
 ```
 
-## Options
+## API
+
+```js
+var koa = require('koa');
+var app = koa();
+app.use(require('koa-static')(root, opts));
+```
+
+* `root` root directory string. nothing above this root directory can be served
+* `opts` options object.
+
+### Options
 
  - `maxage` Browser cache max-age in milliseconds. defaults to 0
  - `hidden` Allow transfer of hidden files. defaults to false