reorganization + typo fix...

Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
Alex A. Naanou 2018-08-18 13:13:35 +03:00
parent a051aab1e7
commit 89f95bb6f1

View File

@ -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: