Create README.md

This commit is contained in:
Romain Prieto 2014-05-08 13:07:32 +10:00
parent 635d779252
commit 3c7dec4e63

23
README.md Normal file
View file

@ -0,0 +1,23 @@
# restify-cors-middleware
> CORS middleware with full [W3C spec](www.w3.org/TR/cors) support.
## Usage
```js
var corsMiddleware = require('restify-cors-middleware');
var cors = corsMiddleware({
origins: ['http://api.myapp.com', 'http://web.myapp.com'],
allowHeaders: ['API-Token'],
exposeHeaders: ['API-Token-Expiry']
});
server.pre(cors.preflight);
server.use(cors.actual);
```
## Compliance to the spec
See [unit tests](https://github.com/TabDigital/restify-cors-middleware/tree/master/test)
for examples of preflight and actual requests.