diff --git a/README.md b/README.md index ff9f796..1abb636 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,9 @@ XXX Intro - [Object diff](#object-diff) + - [Introduction](#introduction) - [Motivation](#motivation) - [Goals / Features](#goals--features) - - [Introduction](#introduction) - [Installation and loading](#installation-and-loading) - [Diff](#diff) - [Diff class API](#diff-class-api) @@ -25,22 +25,6 @@ XXX Intro - [License](#license) -## Motivation - -XXX - -### Goals / Features -- Full JSON *diff* support -- Support for JavaScript objects without restrictions -- ~~Optional attribute order support~~ (not done yet) -- ~~Support extended Javascript types: Map, Set, ...etc.~~ (feasibility testing) -- *Text diff* support -- Configurable and extensible implementation -- As simple as possible - -XXX alternatives - - ## Introduction Let's start with a couple of objects: @@ -128,7 +112,7 @@ var PERSON = { name: STRING, age: NUMBER, hair: OR( - 'blind', + 'blond', 'blonde', 'black', 'red', @@ -145,6 +129,22 @@ cmp(Bill, PERSON) // -> true ``` +## Motivation + +XXX + +### Goals / Features +- Full JSON *diff* support +- Support for JavaScript objects without restrictions +- ~~Optional attribute order support~~ (not done yet) +- ~~Support extended Javascript types: Map, Set, ...etc.~~ (feasibility testing) +- *Text diff* support +- Configurable and extensible implementation +- As simple as possible + +XXX alternatives + + ## Installation and loading Install the package: