Docs: table of contents

Author: delvedor

README.md

@@ -17,6 +17,20 @@ JSON.stringify obj x 1,763,980 ops/sec ±1.30% (88 runs sampled)
 fast-json-stringify obj x 5,085,148 ops/sec ±1.56% (89 runs sampled)
 ```
 
+#### Table of contents:
+- <a href="#example">`Example`</a>
+- <a href="#api">`API`</a>
+ - <a href="#fastJsonStringify">`fastJsonStringify`</a>
+ - <a href="#specific">`Specific use cases`</a>
+ - <a href="#required">`Required`</a>
+ - <a href="#missingFields">`Missing fields`</a>
+ - <a href="#patternProperties">`Pattern Properties`</a>
+ - <a href="#additionalProperties">`Additional Properties`</a>
+- <a href="#acknowledgements">`Acknowledgements`</a>
+- <a href="#license">`License`</a>
+
+
+<a name="example"></a>
 ## Example
 
 ```js
@@ -48,9 +62,9 @@ console.log(stringify({
   reg: /"([^"]|\\")*"/
 }))
 ```
-
+<a name="api"></a>
 ## API
-
+<a name="fastJsonStringify"></a>
 ### fastJsonStringify(schema)
 
 Build a `stringify()` function based on
@@ -68,13 +82,15 @@ Supported types:
 
 And nested ones, too.  
 
+<a name="specific"></a>
 #### Specific use cases
 
 | Instance   | Serialized as                |
 | -----------|------------------------------|
 | `Date`     | `string` via `toISOString()` |
 | `RegExp`   | `string`                     |
 
+<a name="required"></a>
 #### Required
 You can set specific fields of an object as required in your schema, by adding the field name inside the `required` array in your schema.  
 Example:
@@ -95,6 +111,7 @@ const schema = {
 ```
 If the object to stringify has not the required field(s), `fast-json-stringify` will throw an error.
 
+<a name="missingFields"></a>
 #### Missing fields
 If a field *is present* in the schema (and is not required) but it *is not present* in the object to stringify, `fast-json-stringify` will not write it in the final string.  
 Example:
@@ -109,8 +126,7 @@ const stringify = fastJson({
     mail: {
       type: 'string'
     }
-  },
-  required: ['mail']
+  }
 })
 
 const obj = {
@@ -120,6 +136,7 @@ const obj = {
 console.log(stringify(obj)) // '{"mail":"mail@example.com"}'
 ```
 
+<a name="patternProperties"></a>
 #### Pattern properties
 `fast-json-stringify` supports pattern properties as defined inside JSON schema.  
 *patternProperties* must be an object, where the key is a valid regex and the value is an object, declared in this way: `{ type: 'type' }`.  
@@ -151,7 +168,9 @@ const obj = {
   matchnum: 3
 }
 
-console.log(stringify(obj)) // '{"nickname":"nick","matchfoo":"42","otherfoo":"str","matchnum":3}'
+console.log(stringify(obj)) // '{"matchfoo":"42","otherfoo":"str","matchnum":3,"nickname":"nick"}'
+```
+
 <a name="additionalProperties"></a>
 #### Additional properties
 `fast-json-stringify` supports additional properties as defined inside JSON schema.  
@@ -193,10 +212,12 @@ const obj = {
 console.log(stringify(obj)) // '{"matchfoo":"42","otherfoo":"str","matchnum":3,"nomatchstr":"valar morghulis",nomatchint:"313","nickname":"nick"}'
 ```
 
+<a name="acknowledgements"></a>
 ## Acknowledgements
 
 This project was kindly sponsored by [nearForm](http://nearform.com).
 
+<a name="license"></a>
 ## License
 
 MIT