git-description

Manage the description of a repository.

Usage no npm install needed!

<script type="module">
  import gitDescription from 'https://cdn.skypack.dev/git-description';
</script>

README

git-description Build status for git-description on Circle CI.

Manage the description of a repository.

Why?

  • Spread your intent far and wide.
  • Displayed in tools like Tower.
  • Satisfies your inner perfectionist.

Install

npm install git-description --save

Usage

Get it into your program.

const gitDescription = require('git-description');

Set the description of a repository.

gitDescription.set('An awesome project.').then(() => {
    console.log('Finished saving repo description.');
});

Contributing

See our contributing guidelines for more details.

  1. Fork it.
  2. Make a feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request.

License

MPL-2.0 © Seth Holladay

Go make something, dang it.