Merge pull request #53 from yahoo/api

Move API doc to docs dir

Author: Vijar

CONTRIBUTING.md

@@ -3,5 +3,5 @@ Contributing Code to `fetchr`
 
 Please be sure to sign our [CLA][] before you submit pull requests or otherwise contribute to `fetchr`. This protects developers, who rely on [BSD license][].
 
-[BSD license]: https://github.com/ouchtown/fetchr/blob/master/LICENSE.md
+[BSD license]: https://github.com/yahoo/fetchr/blob/master/LICENSE.md
 [CLA]: https://yahoocla.herokuapp.com/

README.md

@@ -170,74 +170,9 @@ new Fetcher({
 
 This `_csrf` will be sent in all XHR requests as a query parameter so that it can be validated on the server.
 
-[//]: # (API_START)
-## Fetchr API
+## API
 
-### Constructor(options)
-
-Creates a new fetchr plugin instance with the following parameters:
-
- * `options`: An object containing the plugin settings
- * `options.req` (required): The request object.  It can contain per-request/context data.
- * `options.xhrPath` (optional): The path for XHR requests. Will be ignored serverside.
-
-### Static Methods
-
-#### registerFetcher(service)
-
-register a service with fetchr
-
-```js
-var Fetcher = require('fetchr');
-
-Fetcher.registerFetcher(myDataService);
-```
-
-#### getFetcher(resource)
-
-getter for a service by resource
-
-```js
-var Fetcher = require('fetchr');
-var myDataService = {
-    name: 'serviceResource', // resource
-    read: function (){}// custom read logic
-};
-
-Fetcher.registerFetcher(myDataService);
-Fetcher.getFetcher('serviceResource'); // returns myDataService
-```
-
-#### middleware
-
-getter for fetchr's express/connect middleware.
-
-```js
-var Fetcher = require('fetchr'),
-    express = require('express'),
-    app = express();
-
-app.use('/myCustomAPIEndpoint', Fetcher.middleware());
-```
-
-### Instance Methods
-
-#### read(resource, params, config, callback)
-
-Call the read method of a service.
-
-#### create(resource, params, body, config, callback)
-
-Call the create method of a service.
-
-#### update(resource, params, body, config, callback)
-
-Call the update method of a service.
-
-#### delete(resource, params, config, callback)
-
-Call the delete method of a service.
-[//]: # (API_STOP)
+See [Fetchr API](https://github.com/yahoo/fetchr/blob/master/docs/fetchr.md).
 
 ## License
 

docs/fetchr.md

@@ -0,0 +1,66 @@
+# Fetchr API
+
+## Constructor(options)
+
+Creates a new fetchr plugin instance with the following parameters:
+
+ * `options`: An object containing the plugin settings
+ * `options.req` (required): The request object.  It can contain per-request/context data.
+ * `options.xhrPath` (optional): The path for XHR requests. Will be ignored serverside.
+
+## Static Methods
+
+### registerFetcher(service)
+
+register a service with fetchr
+
+```js
+var Fetcher = require('fetchr');
+
+Fetcher.registerFetcher(myDataService);
+```
+
+### getFetcher(resource)
+
+getter for a service by resource
+
+```js
+var Fetcher = require('fetchr');
+var myDataService = {
+    name: 'serviceResource', // resource
+    read: function (){}// custom read logic
+};
+
+Fetcher.registerFetcher(myDataService);
+Fetcher.getFetcher('serviceResource'); // returns myDataService
+```
+
+### middleware
+
+getter for fetchr's express/connect middleware.
+
+```js
+var Fetcher = require('fetchr'),
+    express = require('express'),
+    app = express();
+
+app.use('/myCustomAPIEndpoint', Fetcher.middleware());
+```
+
+## Instance Methods
+
+### read(resource, params, config, callback)
+
+Call the read method of a service.
+
+### create(resource, params, body, config, callback)
+
+Call the create method of a service.
+
+### update(resource, params, body, config, callback)
+
+Call the update method of a service.
+
+### delete(resource, params, config, callback)
+
+Call the delete method of a service.