Skip to content

Commit c500a1e

Browse files
author
dlunny
committed
Updates readme & bumps version
1 parent cf50392 commit c500a1e

File tree

2 files changed

+23
-13
lines changed

2 files changed

+23
-13
lines changed

README.md

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## git-labelmaker
2-
:flags: Edit git labels from the command line using **`git-labelmaker`**! You can easily add or remove git-labels, making it easier for your project to adhere to a sane labelling scheme.
1+
## :flags: git-labelmaker
2+
Edit GitHub labels from the command line using **`git-labelmaker`**! You can easily add or remove GitHub labels, making it easier for your projects to adhere to a sane labelling scheme.
33

44
### Install
55

@@ -11,26 +11,36 @@ npm i -g git-labelmaker
1111

1212
### Usage
1313

14-
Using this bad boy is a breeze. First `cd` into your repository and then run the command without any arguments:
14+
Using this bad boy is a breeze. First `cd` into your git repository, run the command and follow the prompts!
1515

1616
```
1717
git-labelmaker
1818
```
1919

20-
You'll then be able to add or remove labels for the repository you are in.
20+
#### Token
2121

22-
If it's the first time running the command, you will be prompted for a GitHub token, which you can [generate over here](https://github.com/settings/tokens).
22+
If it's the first time running it, you will be prompted for a GitHub token, which you can [generate over here](https://github.com/settings/tokens). You can reset your token later, but otherwise `git-labelmaker` will remember it for you.
2323

24-
### About
24+
#### Add Custom Labels
2525

26-
`git-labelmaker` is essentially a sugar for the [`git-label`](https://github.com/jasonbellamy/git-label) package written by [**jasonbellamy**](https://github.com/jasonbellamy). It provides a few nice features that make creating custom labels a breeze, such as:
26+
You can add your own labels one at a time. You will be prompted for your new label's text and color. Include the `#` in front of your 3 or 6 digit hex color. Add as many as you like!
2727

28-
- stores your GH token so you don't have to keep whipping it out
29-
- learns the gh repo name so you don't need to add it to a config
30-
- removal based on the current labels in the repo
31-
- wraps the whole thing in pretty [**inquirer.js**](https://github.com/SBoudrias/Inquirer.js/) prompts
28+
#### Add Labels From Package
29+
30+
If you have a labels package in your current directory that you would like to use for adding labels, just supply the path and name of that file. So like if it's at the root of the current directory, just `labels.json`.
31+
32+
It must be a valid `.json` file, and must match the expected format. Check out [these really good ones](https://github.com/jasonbellamy/git-label-packages/tree/master/packages) if you need a template.
33+
34+
#### Remove Labels
35+
36+
You can also remove labels. Just select the ones you want to ditch and :boom: they're gone.
37+
38+
> **Related:**
39+
- [`git-label`](https://github.com/jasonbellamy/git-label) by [**jasonbellamy**](https://github.com/jasonbellamy), which `git-labelmaker` uses to add and remove labels
40+
- [`git-label-packages`](https://github.com/jasonbellamy/git-label-packages) is a really good set of default packages if you really want to level up your projects
41+
- [`git-label-faces`](https://github.com/himynameisdave/git-label-faces) is a joke package set that you should totally never use for real
3242

3343
---
3444

3545
*Created by [Dave Lunny](https://twitter.com/dave_lunny) in the wonderful year of 2016.*
36-
*Licensed under MIT*
46+
*Licensed under MIT :hand:*

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "git-labelmaker",
3-
"version": "0.4.0",
3+
"version": "0.5.0",
44
"description": "Create git labels from the command line using git-label!",
55
"main": "index.js",
66
"scripts": {

0 commit comments

Comments
 (0)