README, bench, example.

Author: mcollina

README.md

@@ -1,2 +1,57 @@
 # fast-json-stringify
-go away
+
+__fast-json-stringify__ is x5 faster than `JSON.stringify()`.
+
+Benchmarks:
+
+```
+JSON.stringify x 1,681,132 ops/sec ±0.59% (88 runs sampled)
+fast-json-stringify x 5,117,658 ops/sec ±1.44% (87 runs sampled)
+```
+
+## Example
+
+```js
+const fastJson = require('fast-json-stringify')
+const stringify = fastJson({
+  title: 'Example Schema',
+  type: 'object',
+  properties: {
+    firstName: {
+      type: 'string'
+    },
+    lastName: {
+      type: 'string'
+    },
+    age: {
+      description: 'Age in years',
+      type: 'integer'
+    }
+  }
+})
+
+console.log(stringify({
+  firstName: 'Matteo',
+  lastName: 'Collina',
+  age: 32
+}))
+```
+
+## API
+
+### fastJsonStringify(schema)
+
+Build a `stringify()` function based on
+[jsonschema](http://json-schema.org/).
+
+Supported types:
+
+ * `integer'
+ * `number'
+ * `array'
+ * `object'
+ * `null'
+
+## License
+
+MIT

bench.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const benchmark = require('benchmark')
+const safeStringify = require('fast-safe-stringify')
 const suite = new benchmark.Suite()
 
 const schema = {
@@ -18,8 +19,7 @@ const schema = {
       'type': 'integer',
       'minimum': 0
     }
-  },
-  'required': ['firstName', 'lastName']
+  }
 }
 
 const obj = {
@@ -38,6 +38,10 @@ suite.add('fast-json-stringify', function () {
   stringify(obj)
 })
 
+suite.add('fast-safe-stringify', function () {
+  safeStringify(obj)
+})
+
 suite.on('complete', print)
 
 suite.run()

example.js

@@ -0,0 +1,25 @@
+'use strict'
+
+const fastJson = require('.')
+const stringify = fastJson({
+  title: 'Example Schema',
+  type: 'object',
+  properties: {
+    firstName: {
+      type: 'string'
+    },
+    lastName: {
+      type: 'string'
+    },
+    age: {
+      description: 'Age in years',
+      type: 'integer'
+    }
+  }
+})
+
+console.log(stringify({
+  firstName: 'Matteo',
+  lastName: 'Collina',
+  age: 32
+}))

package.json

@@ -25,6 +25,7 @@
   "homepage": "https://github.com/mcollina/fast-json-stringify#readme",
   "devDependencies": {
     "benchmark": "^2.1.1",
+    "fast-safe-stringify": "^1.0.9",
     "is-my-json-valid": "^2.13.1",
     "pre-commit": "^1.1.3",
     "standard": "^7.1.2",