Skip to content

Latest commit

 

History

History
67 lines (48 loc) · 2.66 KB

.verb.md

File metadata and controls

67 lines (48 loc) · 2.66 KB
Raw

Full support for:

(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 for more details.

Usage

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

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 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.