Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dimfu committed Jun 14, 2023
1 parent 64518e8 commit 310d6ed
Showing 1 changed file with 28 additions and 1 deletion.
29 changes: 28 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,28 @@
# monkeytype-wrapper
# monkeytype-wrapper

A wrapper to work with Monkeytype API

## Installation & Usage

```
npm install --save monkeytype-wrapper
```

```js
import MonkeyWrapper from 'monkeytype-wrapper'

const monkey = new MonkeyWrapper(key)

// Using methods
monkey.users.profile('John Doe').then((res) => {
console.log(res.name) // John Doe
}).catch((e) => {
console.error(e)
})
```

More detailed examples will be documented soon

## License

Distributed under the MIT License. See [LICENSE](LICENSE) for more information.

0 comments on commit 310d6ed

Please sign in to comment.