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-descriptionNote: You will need to set credentials using ghauth if you plan on setting data. This will be used for the CLI tool, and the token will be stored in your ~Library. To edit this file later, see this module. Your token will need to have access to repo credentials. You can manually manage these here.
If you are importing this package and using the index.js file, or running the tests, you will need to set the token as an environmental variable. Set it to: GH_DESCRIPTION_TOKEN.
Usage
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 unicornsContribute
PRs and issues gladly accepted!
License
MIT © Richard Littauer