Merge pull request #403 from benjamine/vnext

docs: fix readme and demo examples

Author: benjamine

README.md

@@ -29,7 +29,8 @@
 - reverse a delta, unpatch (eg. revert object to its original state using a delta)
 - multiple output formats:
   - pure JSON, low footprint [delta format](docs/deltas.md)
-  - annotated JSON (html), to help explain the format with annotations
+  - <span style="background-color: #bbffbb; color: black;">visual</span> <span style="background-color: #ffbbbb; color:black; text-decoration: line-through">diff</span> (html), see [demo](https://jsondiffpatch.com)
+  - annotated JSON (html), to help explain the delta format with annotations
   - JSON Patch ([RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902)), can generate patches, and also apply them
   - console (colored), try running `./node_modules/.bin/jsondiffpatch left.json right.json`
   - write your own! check [Formatters documentation](docs/formatters.md)
@@ -44,20 +45,20 @@
 
 as a CLI:
 
-```sh
+``` sh
 npx jsondiffpatch https://jsondiffpatch.com/demo/left.json https://jsondiffpatch.com/demo/right.json
 ```
 
 ![console_demo!](docs/demo/consoledemo.png)
 
 or as a library:
 
-```ts// sample data
+```ts
+// sample data
 const country = {
   name: 'Argentina',
   capital: 'Buenos Aires',
   independence: new Date(1816, 6, 9),
-  unasur: true,
 };
 
 // clone country, using dateReviver for Date objects
@@ -90,7 +91,8 @@ assert(delta2 === undefined);
 
 Array diffing:
 
-```ts// sample data
+```ts
+// sample data
 const country = {
   name: 'Argentina',
   cities: [
@@ -199,7 +201,8 @@ In a browser, you can load a bundle using a tool like [esm.sh](https://esm.sh) o
 
 ## Options
 
-```tsimport * as jsondiffpatch from 'jsondiffpatch';
+```ts
+import * as jsondiffpatch from 'jsondiffpatch';
 
 // Only import if you want text diffs using diff-match-patch
 import DiffMatchPatch from 'diff-match-patch';

demos/console-demo/demo.ts

@@ -1,5 +1,5 @@
-import * as jsondiffpatch from 'jsondiffpatch/with-text-diffs';
 import * as consoleFormatter from 'jsondiffpatch/formatters/console';
+import * as jsondiffpatch from 'jsondiffpatch/with-text-diffs';
 
 const instance = jsondiffpatch.create({
   objectHash: function (obj) {
@@ -24,7 +24,6 @@ interface Data {
     name: string;
     capital?: string;
     independence?: Date;
-    unasur: boolean;
     population?: number;
   }[];
   spanishName?: string;
@@ -85,73 +84,61 @@ const data: Data = {
       name: 'Argentina',
       capital: 'Buenos Aires',
       independence: new Date(1816, 6, 9),
-      unasur: true,
     },
     {
       name: 'Bolivia',
       capital: 'La Paz',
       independence: new Date(1825, 7, 6),
-      unasur: true,
     },
     {
       name: 'Brazil',
       capital: 'Brasilia',
       independence: new Date(1822, 8, 7),
-      unasur: true,
     },
     {
       name: 'Chile',
       capital: 'Santiago',
       independence: new Date(1818, 1, 12),
-      unasur: true,
     },
     {
       name: 'Colombia',
       capital: 'Bogotá',
       independence: new Date(1810, 6, 20),
-      unasur: true,
     },
     {
       name: 'Ecuador',
       capital: 'Quito',
       independence: new Date(1809, 7, 10),
-      unasur: true,
     },
     {
       name: 'Guyana',
       capital: 'Georgetown',
       independence: new Date(1966, 4, 26),
-      unasur: true,
     },
     {
       name: 'Paraguay',
       capital: 'Asunción',
       independence: new Date(1811, 4, 14),
-      unasur: true,
     },
     {
       name: 'Peru',
       capital: 'Lima',
       independence: new Date(1821, 6, 28),
-      unasur: true,
     },
     {
       name: 'Suriname',
       capital: 'Paramaribo',
       independence: new Date(1975, 10, 25),
-      unasur: true,
     },
     {
       name: 'Uruguay',
       capital: 'Montevideo',
       independence: new Date(1825, 7, 25),
-      unasur: true,
     },
     {
       name: 'Venezuela',
       capital: 'Caracas',
       independence: new Date(1811, 6, 5),
-      unasur: true,
     },
   ],
 };
@@ -167,7 +154,6 @@ data.countries.pop();
 data.countries[0].capital = 'Rawson';
 data.countries.push({
   name: 'Antártida',
-  unasur: false,
 });
 
 // modify and move