Merge pull request #1 from theworkflow/enhancement/docs

Enhancement/docs

Author: theworkflow

LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2016 Jeremiah Harlan <jeremiah.harlan@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,2 +1,106 @@
-JSON API Errors
-===============
+# JSON API Errors
+
+Create errors using [JSON API errors format](http://jsonapi.org/format/#errors)
+
+[![npm package](https://nodei.co/npm/json-api-errors.png?downloads=true&downloadRank=true&stars=true)][package]
+
+
+[![version](https://img.shields.io/npm/v/json-api-errors.svg?style=flat-square)][version]
+[![build](https://img.shields.io/travis/theworkflow/json-api-errors/master.svg?style=flat-square)][build]
+[![license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)][license]
+[![climate](https://img.shields.io/codeclimate/github/theworkflow/json-api-errors.svg?style=flat-square)][climate]
+[![coverage](https://img.shields.io/codeclimate/coverage/github/theworkflow/json-api-errors.svg?style=flat-square)][coverage]
+
+### Installation
+
+`$ npm install json-api-errors`
+
+### Usage
+
+#### `Errors.createSingle(id, message, [meta])`
+
+Create a single errors object.
+
+- `id` (String)
+ - required
+- `message` (String)
+ - required
+- `meta` (Object | String)
+ - optional
+
+```javascript
+const Errors = require('json-api-errors')
+
+var errors = new Errors()
+var err = errors.createSingle('CUSTOM_ERROR', 'Custom error message')
+
+console.log(err)
+// {
+//   errors: [{ id: 'CUSTOM_ERROR', message: 'Custom error message' }]
+// }
+```
+
+#### `Errors.add(id, message, [meta])`
+
+Add an error to the errors array
+
+- `id` (String)
+ - required
+- `message` (String)
+ - required
+- `meta` (Object | String)
+ - optional
+
+```javascript
+const Errors = require('json-api-errors')
+
+var errors = new Errors()
+errors.add('CUSTOM_ERROR', 'Custom error message')
+```
+
+#### `Errors.get()`
+
+Retreive all errors. Errors are returned in a JSON format
+
+```javascript
+const Errors = require('json-api-errors')
+
+var errors = new Errors()
+errors.add('CUSTOM_ERROR', 'Custom error message')
+
+var errs = errors.get()
+// {
+//   errors: [{ id: 'CUSTOM_ERROR', message: 'Custom error message' }]
+// }
+```
+
+#### `Errors.clear()`
+
+Remove all errors
+
+```javascript
+const Errors = require('json-api-errors')
+
+var errList, errors = new Errors()
+
+errors.add('CUSTOM_ERROR', 'Custom error message')
+
+errList = errors.get()
+console.log(errList.errors) // Length is 1
+
+errors.clear()
+errList = errors.get()
+
+console.log(errList.errors) // Length is 0
+```
+
+### Tests
+
+`$ npm test`
+
+[package]: https://nodei.co/npm/json-api-errors
+[version]: https://www.npmjs.com/package/json-api-errors
+[build]: https://travis-ci.org/theworkflow/api-util
+[license]: https://raw.githubusercontent.com/theworkflow/json-api-errors/master/LICENSE
+[climate]: https://codeclimate.com/github/theworkflow/json-api-errors
+[coverage]: https://codeclimate.com/github/theworkflow/json-api-errors/coverage

package.json

@@ -1,6 +1,6 @@
 {
   "name": "json-api-errors",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "JSON api errors formatter",
   "main": "errors.js",
   "scripts": {