https://github.com/bukinoshita/git-topics
Auto create Github topics for repositories
https://github.com/bukinoshita/git-topics
cli git github repo repository topic topics
Last synced: 2 months ago
JSON representation
Auto create Github topics for repositories
- Host: GitHub
- URL: https://github.com/bukinoshita/git-topics
- Owner: bukinoshita
- License: mit
- Created: 2017-10-03T23:02:23.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-06T23:07:47.000Z (over 2 years ago)
- Last Synced: 2025-03-13T19:50:41.505Z (3 months ago)
- Topics: cli, git, github, repo, repository, topic, topics
- Language: JavaScript
- Homepage:
- Size: 272 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 14
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# git-topics [](https://travis-ci.org/bukinoshita/git-topics)
> Auto create Github topics for repositories
## Install
```bash
$ yarn add git-topics
```
## Usage
```js
const gitTopics = require('git-topics')
const token = 'foo'
gitTopics(token, {
topics: ['github', 'git'],
project: 'bukinoshita/git-topics'
}).then(res => res)
// => "['github', 'git']"
```
## API
### gitTopics(token, [options])
Returns a `promise`
#### token
Type: `string`
Required
[Github access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/)
#### options
Type: `object`
##### topics
Type: `array`
Default: It will try to get `keywords` from `package.json`
Array of topics to be added to Github
##### project
Type: `string`
Default: It will try to get `repository` from `package.json`
Github project to add topics
## Related
- [git-topics-cli](https://github.com/bukinoshita/git-topics-cli) — CLI for this module
## License
MIT © [Bu Kinoshita](https://bukinoshita.io)