Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
barelyhuman committed Mar 16, 2024
1 parent 4f3b8db commit 64265f2
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

> Straightforward object picker and walkers
### Why?

I have re-written this utility at least 3 times now and each time I end up with
something where either an array or an object is a after thought. A lot of times
it's okay to use the Array methods with the picker but if I can simplify the
most common case of picking from an array inside the object then, I might as
well do this.

### Usage

```sh
Expand All @@ -13,3 +21,9 @@ import { pick } from '@dumbjs/pick'
import { get } from '@dumbjs/pick/get'
import { set } from '@dumbjs/pick/set'
```

### Examples

- [`pick`](/tests/pick.test.ts)
- [`get`](/tests/get.test.ts)
- [`set`](/tests/set.test.ts)

0 comments on commit 64265f2

Please sign in to comment.