notes and docs...

Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
Alex A. Naanou 2018-08-17 13:53:32 +03:00
parent 2e7054bc57
commit 1deed17e49
2 changed files with 6 additions and 3 deletions

View File

@ -5,7 +5,7 @@ XXX Intro
- [Object diff](#object-diff)
- [Motivation](#motivation)
- [Goals / Features](#goals--features)
- [General](#general)
- [Introduction](#introduction)
- [Installation and loading](#installation-and-loading)
- [Diff](#diff)
- [Diff class API](#diff-class-api)
@ -32,15 +32,16 @@ XXX
### Goals / Features
- Full JSON *diff* support
- Support for JavaScript objects without restrictions
- *Text diff* support
- ~~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
## General
## Introduction
```javascript
var {Diff, cmp} = require('object-diff')

View File

@ -35,6 +35,8 @@ var MIN_TEXT_LENGTH = 100
// - objdiff / object-diff
// - diffcmp / diff-cmp
// - compare
// - revise docs...
// ...should be simpler to enter, maybe example-oriented intro
//
//
//---------------------------------------------------------------------