topics

topics

Get and update GitHub repository topics.

Install

Install with npm:

$ npm install --save topics

Usage

This library uses github-base. Visit that library's github repository for documentation about all available options and authentication options.

var topics = require('topics');

Example response

Status: 200 OK

{
  "names": [
    "octocat",
    "atom",
    "electron",
    "API"
  ]
}

API

Params

• options {Object}
• returns {Object}

Example

var options = {
  username: 'your_username',
  password: 'your_password'
};

topics('micromatch/micromatch', options)
  .then(function(topics) {
    console.log('topics', topics);
  })
  .catch(console.error)

.get

List all topics for a repository.

Params

• options {Object}
• returns {Object}

Example

var options = {
  username: 'your_username',
  password: 'your_password'
};

topics.get('micromatch/micromatch', options)
  .then(function(topics) {
    console.log('topics', topics);
  })
  .catch(console.error)

.put

Replace all topics for a repository.

Params

• options {Object}
• returns {Object}

Example

var options = {
  username: 'your_username',
  password: 'your_password',

  // new topics to use (overwrites all existing topics)
  names: [
    'foo',
    'bar',
    'baz'
  ]
};

topics.put('micromatch/micromatch', options)
  .then(function(topics) {
    console.log('topics', topics);
  })
  .catch(console.error)

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme, v0.6.0, on August 07, 2017.