-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
28 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |