Skip to content

Commit 5add707

Browse files
Update README.md
1 parent cc28898 commit 5add707

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

README.md

+16-3
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ yarn global add ghlabels
2525

2626
### Basic usage
2727

28-
You can provide options as arguments or leave then blank and they will be asked.
28+
You can provide options as arguments or leave then blank and they will be prompted.
2929

3030
```sh
3131
ghlabels --owner foo --repo bar --token foobar --configFile ./path/somefile
@@ -36,15 +36,21 @@ Note: As an alternative you can provide options as enviroment variables (e.g. GI
3636
### Copy from another repo
3737

3838
```sh
39-
ghlabels --sourceOwner seegno --sourceRepo github-labels --targetOwner foo --targetRepo bar --token foobar
39+
ghlabels copy --sourceOwner seegno --sourceRepo github-labels --targetOwner foo --targetRepo bar --token foobar
40+
```
41+
42+
### List
43+
44+
```sh
45+
ghlabels list --owner seegno --repo github-labels
4046
```
4147

4248
### Client
4349

4450
You can also import ghlabels client and use it as a module:
4551

4652
```js
47-
import { copyLabelsFromRepo, updateLabels } from 'ghlabels';
53+
import { copyLabelsFromRepo, listLabels, updateLabels } from 'ghlabels';
4854

4955
// Example of copying labels from a source repo.
5056
copyLabelsFromRepo({
@@ -53,6 +59,13 @@ copyLabelsFromRepo({
5359
token: 'foobar'
5460
});
5561

62+
// Example of listing all labels from a repo.
63+
listLabels({
64+
owner: 'seegno',
65+
repo: 'github-labels',
66+
token: 'foobar'
67+
});
68+
5669
// Example of updating all labels from a repo.
5770
updateLabels({
5871
sourceOwner: 'seegno',

0 commit comments

Comments
 (0)