Package Exports
- gh-description
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (gh-description) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
gh-description 
Set and get a GitHub repository description
Install
$ npm install --save gh-descriptionUsage
const ghDescription = require('gh-description');
ghDescription('RichardLitt/gh-description');
//=> 'Set and get a GitHub repository description'
ghDescription('RichardLitt/gh-description', 'unicorns & rainbows');
//=> 'unicorns & rainbows'API
ghDescription(repoName, description, [options], token)
repoName
Type: string
The name for the repository to test.
description
Type: string
The new description to set. To set, you must also supply the repoName first.
options
None.
token
Your GitHub access token, if not set as an env variable or supplied in the CLI.
CLI
$ npm install --global gh-description$ gh-description --help
Usage
$ gh-description
Examples
$ gh-description
Current description: Set and get a GitHub repository description
$ gh-description RichardLitt/gh-description 'ponies and unicorns'
New description: ponies and unicornsLicense
MIT © Richard Littauer