Skip to content

Commit ece376a

Browse files
committed
Update README
1 parent ada03d4 commit ece376a

2 files changed

Lines changed: 9 additions & 12 deletions

File tree

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,14 @@
22

33
Compare changes between two datasets.
44

5-
## Packages
5+
#### Packages
66

7-
This repository is a monorepo managed with [Lerna](https://github.com/lerna/lerna). We actually publish [several packages](https://github.com/gilbarbara/tree-changes/blob/master/packages) to npm from the same codebase, including:
8-
9-
| Package | Version | Description |
10-
| ----------------------------------------------- | ------------------------------------------------------------ | ------------------------------------ |
11-
| [tree-changes](packages/tree-changes) | [![NPM](https://badge.fury.io/js/tree-changes.svg)](https://www.npmjs.com/package/tree-changes) | Compare changes between two datasets |
12-
| [tree-changes-hook](packages/tree-changes-hook) | [![NPM](https://badge.fury.io/js/tree-changes-hook.svg)](https://www.npmjs.com/package/tree-changes-hook) | React hook for tree-changes |
7+
| Package | Version | Description |
8+
|-------------------------------------------------|-----------------------------------------------------------------------------------------------------------|--------------------------------------|
9+
| [tree-changes](packages/tree-changes) | [![NPM](https://badge.fury.io/js/tree-changes.svg)](https://www.npmjs.com/package/tree-changes) | Compare changes between two datasets |
10+
| [tree-changes-hook](packages/tree-changes-hook) | [![NPM](https://badge.fury.io/js/tree-changes-hook.svg)](https://www.npmjs.com/package/tree-changes-hook) | React hook for tree-changes |
1311

1412
## Changes
1513

16-
Detailed release notes for a given version can be found in the [releases page](https://github.com/gilbarbara/tree-changes/releases).
14+
Detailed release notes for a given version can be found on the [releases page](https://github.com/gilbarbara/tree-changes/releases).
15+

packages/tree-changes/README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44

55
Compare changes between two datasets.
66

7-
> The React hook introduced in v0.6 now has its own package: [tree-changes-hook](https://github.com/gilbarbara/tree-changes/tree/master/packages/tree-changes-hook).
8-
97
## Setup
108

119
```bash
@@ -14,7 +12,7 @@ npm install tree-changes
1412

1513
## Usage
1614

17-
```typescript
15+
```ts
1816
import treeChanges from 'tree-changes';
1917

2018
const previousData = {
@@ -64,7 +62,7 @@ changed(1); // true
6462
changed('1.id', 4); // true
6563
```
6664

67-
> It uses [@gilbarbara/deep-equal](https://github.com/gilbarbara/deep-equal) to compare properties.
65+
> This library uses [@gilbarbara/deep-equal](https://github.com/gilbarbara/deep-equal) to compare properties.
6866
6967
## API
7068

0 commit comments

Comments
 (0)