Skip to content

Commit 77dc1d3

Browse files
committed
Update wording and formatting in README
1 parent 9de6fed commit 77dc1d3

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

README.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ pip install labels
1212

1313
## Authentication
1414

15-
The labels CLI connects to the GitHub API to modify issue labels for a GitHub
15+
The labels CLI connects to the GitHub API to modify labels for a GitHub
1616
repository. Please [create your own personal API token][create token] and
1717
choose the correct token scope based on whether you want to manage issue
1818
labels for a public or a private repository. Then set up two environment
@@ -26,20 +26,18 @@ export LABELS_TOKEN="<GITHUB_TOKEN>"
2626
## Usage
2727

2828
Once you've installed **labels** and set up the environment variables, you're
29-
ready to use the **labels** CLI to manage issue labels for a GitHub
30-
repository. The CLI comes with two commands: ``fetch`` and ``sync``.
31-
32-
Both commands require the owner and the name of the GitHub repository to
33-
fetch from or sync to. By default, **labels** tries to load this information
34-
from your local Git repository based on the URL for the `origin` remote
35-
repository.
29+
ready to use the **labels** CLI to manage labels for a GitHub repository. The
30+
CLI comes with two commands: ``fetch`` and ``sync``. Both commands require
31+
the name of the owner and the name of the GitHub repository to fetch from or
32+
sync to. By default, **labels** tries to load this information from your
33+
local Git repository based on the URL for the `origin` remote repository.
3634

3735
For example, if you run **labels** from your local clone of the [earth
3836
][earth_repo] repository with `origin` set to
39-
`[email protected]:hackebrot/earth.git`, owner will be `hackebrot` and repo will
37+
`[email protected]:hackebrot/earth.git` owner will be `hackebrot` and repo will
4038
be `earth`. 🌍
4139

42-
You can override each of these values manually using the following CLI
40+
You can override one or both of these values manually using the following CLI
4341
options:
4442

4543
```text
@@ -49,15 +47,15 @@ options:
4947

5048
### Fetch
5149

52-
When you're using **labels** for the first time, you want to fetch
50+
When you use **labels** for the first time, you will start by fetching
5351
information about the existing labels for your GitHub project. The CLI will
5452
then write a [TOML][toml] file to your computer with the retrieved
55-
information. The default filename for this file is ``labels.toml`` in your
56-
current working directory and can be changed by passing the
57-
``-f, --filename PATH`` option followed by a path.
53+
information. The default name for this file is ``labels.toml`` in your
54+
current working directory and can be changed by passing the ``-f, --filename
55+
PATH`` option followed by the path to where you want to write to.
5856

5957
```text
60-
$ labels fetch -o hackebrot -r pytest-emoji
58+
labels fetch -o hackebrot -r pytest-emoji
6159
```
6260

6361
```toml
@@ -89,11 +87,11 @@ name = "good first issue"
8987

9088
### Sync
9189

92-
Now that you have a file on your computer that represents your GitHub issue
93-
labels, you can edit this file and then run **labels sync** to update the
94-
remote repository. But first let's look into how that works... 🔍
90+
Now that you have a file on your computer that represents your GitHub labels,
91+
you can edit this file and then run **labels sync** to update the remote
92+
repository. But first let's look into how that works... 🔍
9593

96-
Representation of a GitHub issue label in the written TOML file:
94+
Representation of a GitHub label in the written TOML file:
9795

9896
```toml
9997
[docs]
@@ -105,14 +103,16 @@ name = "docs"
105103
The section name (``[docs]`` in the example above) represents the name of the
106104
label for that repository and is identical to the ``name`` field when running
107105
``labels fetch``. Do not edit the section name of existing labels yourself!
106+
⚠️
107+
108108
The fields ``color``, ``description`` and ``name`` are parameters that you
109109
can edit with the **labels** CLI.
110110

111111
- ``name`` - The name of the label
112112
- ``description`` - A short description of the label
113-
- ``color`` - The hexadecimal color code for the label, without the leading ``#``
113+
- ``color`` - The hexadecimal color code for the label without the leading ``#``
114114

115-
You can make the following changes to issue labels for your repo:
115+
You can make the following changes to labels for your repo:
116116

117117
- You can **delete** a label by removing the corresponding section from the
118118
labels file 🗑
@@ -133,7 +133,7 @@ Check your label changes before syncing by using the ``dryrun`` CLI option:
133133
Example usage:
134134

135135
```text
136-
$ labels sync -n -o hackebrot -r pytest-emoji
136+
labels sync -n -o hackebrot -r pytest-emoji
137137
```
138138

139139
```text
@@ -153,8 +153,8 @@ Running ``labels sync`` without the ``dryrun`` option also updates the labels
153153
file, so that section names match the ``name`` parameter.
154154

155155
If **labels** encounters any errors while sending requests to the GitHub API,
156-
it will print information about the failure and continue with the next
157-
label until it processed all of the labels.
156+
it will print information about the failure and continue with the next label
157+
until it has processed all of the labels.
158158

159159
## Community
160160

0 commit comments

Comments
 (0)