Merge pull request #52 from yahoo/api

[skip-ci] Update README with API section

Author: Vijar

README.md

@@ -170,6 +170,75 @@ 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
+
+### 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)
+
 ## License
 
 This software is free to use under the Yahoo! Inc. BSD license.