Skip to content

Commit b22de81

Browse files
committed
fix: remove github-label-setup instructions
1 parent b51bc77 commit b22de81

File tree

1 file changed

+9
-24
lines changed

1 file changed

+9
-24
lines changed

README.md

Lines changed: 9 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
**TL;DR:** _Want [beautiful GitHub Labels like these](https://github.com/seantrane/github-label-presets/labels)?_ Want to have them unobtrusively synced with your repos? Want to persist them indefinitely? Want to maintain your own labels? If the answers have been yes, this is definitely not _too long_, please read on.
1212

13-
**TL;DR:2** Really? Still _too long_? From your repo directory, run; `npm install -g @azu/github-label-setup && github-label-setup --token <gh_token> -l @seantrane/github-label-presets`
13+
**TL;DR:2** Really? Still _too long_? From your repo directory, run; `npm install -g github-label-sync && github-label-sync -a <github_token> -l 'https://git.io/fAe5i' <github_name>/<github_repo>`
1414

1515
### Details
1616

@@ -37,43 +37,28 @@ There are many very good examples of GitHub Label strategies. Almost all of them
3737
- `work` = describe situation; `chaotic`, `complex`, `complicated` or `obvious`
3838
- The only labels without prefixes are; `breaking`, `good first issue`, `greenkeeper`, `help`, `stale` and `semantic-release`
3939

40-
The _GitHub Label presets_ are meant to be used with one of two packages:
40+
The _GitHub Label presets_ are meant to be used with [github-label-sync](https://github.com/Financial-Times/github-label-sync):
4141

42-
- [github-label-sync](https://github.com/Financial-Times/github-label-sync)
43-
- _Synchronise your GitHub labels with as few destructive operations as possible - similar labels get renamed._
44-
- Load [label config](https://github.com/Financial-Times/github-label-sync#label-json) via path or URL.
45-
- Run on specified repo via CLI parameter.
46-
- [@azu/github-label-setup](https://github.com/azu/github-label-setup) _(a wrapper of `github-label-sync`)_
47-
- _Opinionated GitHub label setup tool._
48-
- Works without config, using [default opinionated labels](https://github.com/azu/github-label-setup#default-labels).
49-
- Load [label config](https://github.com/Financial-Times/github-label-sync#label-json) via path, URL or [npm package](https://github.com/azu/github-label-setup#npm-packages-for-labels).
42+
- _Synchronise your GitHub labels with as few destructive operations as possible - similar labels get renamed._
43+
- Load [label config](https://github.com/Financial-Times/github-label-sync#label-json) via path or URL.
44+
- Run on specified repo via CLI parameter.
5045

5146
## Usage <a id="usage"></a>
5247

5348
**Required:** [Generate a GitHub Access Token](https://github.com/settings/tokens), provide it via `GITHUB_ACCESS_TOKEN` environment variable. _If you cannot provide token as env-var, you may also pass it via CLI._
5449

55-
### via `github-label-sync` <a id="usage-github-label-sync"></a>
56-
5750
1. Install `npm install -g github-label-sync`
58-
2. Dry-run `github-label-sync -l https://github.com/seantrane/github-label-presets/blob/master/labels.json <github_name>/<github_repo>`
59-
3. Run `github-label-sync -l https://github.com/seantrane/github-label-presets/blob/master/labels.json <github_name>/<github_repo>`
60-
4. _optional:_ provide token via param; `github-label-sync -a <gh_token> -l ...`
61-
62-
### via `@azu/github-label-setup` <a id="usage-github-label-setup"></a>
63-
64-
1. Run `npm install -g @azu/github-label-setup`
65-
2. Go to your git-initiated project repository.
66-
3. Dry-run `github-label-setup -d -l @seantrane/github-label-presets`
67-
4. Run `github-label-setup -l @seantrane/github-label-presets`
68-
5. _optional:_ provide token via param; `github-label-setup --token <gh_token> -l ...`
51+
2. Dry-run `github-label-sync -l 'https://git.io/fAe5i' <github_name>/<github_repo>`
52+
3. Run `github-label-sync -l 'https://git.io/fAe5i' <github_name>/<github_repo>`
53+
4. _optional:_ provide token via param; `github-label-sync -a <github_token> -l ...`
6954

7055
### CI/CD
7156

7257
You can use your CI/CD process to automate the periodic syncing of your repository labels. This can help persist order automatically.
7358

7459
### Config your own...
7560

76-
You can provide your own `labels.json`, to either tool, via the `[ -l, --lables ]` argument.
61+
You can provide your own `labels.json` via the `[ -l, --lables ]` argument.
7762

7863
## Contribute <a id="contribute"></a>
7964

0 commit comments

Comments
 (0)