**Full support for:**

- [Gist API](https://developer.github.com/v3/gists/)
- [Gist Comments API](https://developer.github.com/v3/gists/comments/)

_(If you find something missing or encounter a bug, please [create an issue]({%= bugs.url %}/new). Thanks!)_

## Heads up! 

**Breaking changes in v2.0!!!**

Please read the [CHANGELOG](CHANGELOG.md) for more details.

## Usage

Add `gists` to your node.js/JavaScript project with the following code:

```js
const Gists = require('{%= name %}');
const gists = new Gists({
  username: 'your_username', 
  password: 'your_password'
});

// EXAMPLE: Download the Markdown Cheatsheet gist.
gists.get('5854601')
  .then(res => console.log(res))
  .catch(console.error)
```

## API

See the [GitHub Gist API documentation](https://developer.github.com/v3/gists/) for additional details and input options for each method.

{%= apidocs("index.js") %}


## Release history

### v2.0

- Decrecated `.download` in favor of `.get`. Start using `.get` now, as `.download` will be removed in the next major release.
- Decrecated `.del` in favor of `.delete`. Start using `.delete` now, as `.del` will be removed in the next major release.
- Upgraded [github-base][], which is now an ES6 class.


[edit_gist]: https://developer.github.com/v3/gists/#edit-a-gist
[is_starred]: https://developer.github.com/v3/gists/#check-if-a-gist-is-starred
[create_gist]: https://developer.github.com/v3/gists/#create-a-gist
[delete_gist]: https://developer.github.com/v3/gists/#delete-a-gist
[edit_gist]: https://developer.github.com/v3/gists/#edit-a-gist
[fork_gist]: https://developer.github.com/v3/gists/#fork-a-gist
[get_gist]: https://developer.github.com/v3/gists/#get-a-single-gist
[get_revision]: https://developer.github.com/v3/gists/#get-a-specific-revision-of-a-gist
[list_gists]: https://developer.github.com/v3/gists/#list-a-users-gists
[list_public]: https://developer.github.com/v3/gists/#list-all-public-gists
[list_gist_commits]: https://developer.github.com/v3/gists/#list-gist-commits
[list_gist_forks]: https://developer.github.com/v3/gists/#list-gist-forks
[list_starred]: https://developer.github.com/v3/gists/#list-starred-gists
[star_gist]: https://developer.github.com/v3/gists/#star-a-gist
[unstar_gist]: https://developer.github.com/v3/gists/#unstar-a-gist

[list_comments]: https://developer.github.com/v3/gists/comments/#list-comments-on-a-gist
[get_comment]: https://developer.github.com/v3/gists/comments/#get-a-single-comment
[create_comment]: https://developer.github.com/v3/gists/comments/#create-a-comment
[edit_comment]: https://developer.github.com/v3/gists/comments/#edit-a-comment
[delete_comment]: https://developer.github.com/v3/gists/comments/#delete-a-comment