Add documentation

Author: Raphael Freitas

.npmignore

@@ -2,3 +2,4 @@ examples
 tests
 assets
 api
+docs

README.md

@@ -5,6 +5,9 @@ A lightweight Promise based HTTP client, using Fetch API.
 [![Build Status](https://travis-ci.org/raphaelpor/fitch.js.svg?branch=master)](https://travis-ci.org/raphaelpor/fitch.js)
 [![license](https://img.shields.io/npm/l/fitch.svg)](https://github.com/raphaelpor/fitch.js/blob/master/LICENSE.md)
 
+* [Documentation](https://github.com/raphaelpor/fitch.js/blob/master/docs/Intro.md)
+* [License](https://github.com/raphaelpor/fitch.js/blob/master/LICENSE.md)
+
 ## Get started
 ### Install
 ```sh

docs/Config.md

@@ -0,0 +1,66 @@
+# Configuration
+
+Fitch.js allows you to use a custom configuration for your requests. You just need to pass a config object as second parameter of the Fitch.js methods.
+
+## Objects available
+
+**body**
+
+Receives a json object, that is transformed to string by Fitch.js, before send the request.
+
+**Note:** GET method doesn't allow `body` inside config object.
+
+```js
+const req = { body: { name: 'Happy cat' } }
+
+fitch.post(apiUrl, req)
+  .then(data => console.log(data))
+```
+
+**cache**
+
+Same as in Fetch API. [See more at MDN](https://developer.mozilla.org/en-US/docs/Web/API/Request/cache).
+
+**headers**
+
+Same as in Fetch API. [See more at MDN](https://developer.mozilla.org/en-US/docs/Web/API/Request/headers).
+
+**mode**
+
+Same as in Fetch API. [See more at MDN](https://developer.mozilla.org/en-US/docs/Web/API/Request/mode).
+
+**params**
+
+You don't need to pass your URL parameters as string. Fitch.js allows you to pass the parameters inside a object:
+
+```js
+const config = {
+  params: { // transform to '?test1=test-1&test2=test-2'
+    test1: 'test-1',
+    test2: 'test-2',
+  },
+}
+
+fitch.get(apiUrl, config)
+  .then(data => console.log(data))
+```
+
+**raw**
+
+Returns the raw output of Fetch API, so you can work with headers and custom requests like files.
+
+```js
+fitch.get('image.jpg', { raw: true })
+  .then((response) => {
+    if(response.ok) {
+      return response.blob()
+    } else {
+      console.log('Network response was not ok.');
+    }
+  })
+  .then(function(myBlob) {
+    var objectURL = URL.createObjectURL(myBlob)
+    myImage.src = objectURL
+  })
+  .catch(fitch.error)
+```

docs/Intro.md

@@ -0,0 +1,27 @@
+# Get started
+
+Fitch.js is a lightweight client HTTP that uses Fetch API and runs on Node.js and old browsers (with a polyfill).
+
+## Install
+
+You can install Fitch.js using NPM or Yarn:
+```sh
+npm i --save fitch
+# or:
+# yarn add fitch
+```
+
+Now just import Fitch.js and you are ready to make your first request.
+
+```js
+import fitch from 'fitch'
+// or:
+// const fitch = require('fitch')
+
+const apiUrl = 'https://localhost:8080/'
+
+fitch.get(apiUrl)
+  .then(data => console.log(data))
+```
+
+Next: [Learn about the methods available](https://github.com/raphaelpor/fitch.js/blob/master/docs/Methods.md).

docs/Methods.md

@@ -0,0 +1,55 @@
+# Methods available:
+
+**get(url, config)**
+
+```js
+fitch.get(apiUrl, config)
+  .then(data => console.log(data))
+```
+
+**Note:** GET method doesn't allow `body` inside config object.
+
+**post(url, config)**
+
+```js
+const req = { body: { name: 'Happy cat' } }
+
+fitch.post(apiUrl, req)
+  .then(data => console.log(data))
+```
+
+**put(url, config)**
+
+```js
+const req = { body: { name: 'Happy cat' } }
+
+fitch.put(apiUrl, req)
+  .then(data => console.log(data))
+```
+
+**patch(url, config)**
+
+```js
+const req = { body: { name: 'Happy cat' } }
+
+fitch.patch(apiUrl, req)
+  .then(data => console.log(data))
+```
+
+**delete(url, config)**
+
+```js
+fitch.delete(apiUrl)
+  .then(data => console.log(data))
+```
+
+## Handling errors
+If Fetch throws an error, we can handle this using `catch()`:
+
+```js
+fitch.get(apiUrl)
+  .then(data => console.log(data))
+  .catch(fitch.error) // log the error message on the console
+```
+
+**Note:** Fitch.js allows you to use a custom configuration for your requests. [You can learn about it here](https://github.com/raphaelpor/fitch.js/blob/master/docs/Config.md).