Skip to content

Commit

Permalink
feat: improved doc for NPM
Browse files Browse the repository at this point in the history
  • Loading branch information
Neckaros committed Nov 23, 2018
1 parent be60a53 commit 67a758f
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,18 @@ A very simple package to merge to object respecting decoration if any.

## Usage

### Install

Yarn:
```sh
yarn add decorated-merger
```

npm:
```sh
npm i decorated-merger
```

### Merger
Merger function will **merge** all _newObject_ properties **into** the source _object_ merging arrays and sub-objects, respecting all the decorators below.
```typescript
Expand Down Expand Up @@ -113,7 +125,7 @@ export class Person {
- override equatable a array property level.


## Exemple use cases
## Exemple use cases (from tests)
```typescript
@Exclude()
@Equatable<Car>({equal: (a, b) => a.id === b.id})
Expand Down

0 comments on commit 67a758f

Please sign in to comment.