Skip to content

Commit c985f50

Browse files
kevinburke1kevinburke
authored andcommitted
README.md: small cleanups
1 parent 164ff3a commit c985f50

1 file changed

Lines changed: 13 additions & 11 deletions

File tree

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,14 @@ A small commandline app written in Go that allows you to easily create
55
and delete releases of your projects on Github. In addition it allows
66
you to attach files to those releases.
77

8-
It interacts with the [github releases API](http://developer.github.com/v3/repos/releases).
9-
Though it's entirely possibly to [do all these things with
10-
cURL](https://github.com/blog/1645-releases-api-preview), It's not
11-
really that user-friendly. For example, you need to first query the API
12-
to find the id of the release you want, before you can upload an
13-
artifact. `github-release` takes care of those little details.
8+
It interacts with the [github releases API][releases-api]. Though it's entirely
9+
possible to [do all these things with cURL][curl], it's not really that
10+
user-friendly. For example, you need to first query the API to find the id of
11+
the release you want, before you can upload an artifact. `github-release` takes
12+
care of those little details.
13+
14+
[curl]: https://github.com/blog/1645-releases-api-preview
15+
[releases-api]: https://developer.github.com/v3/repos/releases
1416

1517
It might still be a bit rough around the edges, pull requests are
1618
welcome!
@@ -43,11 +45,11 @@ After that you should have a `github-release` executable in your
4345
How to use
4446
==========
4547

46-
**NOTE**: for these examples I've [created a github
47-
token](https://help.github.com/articles/creating-an-access-token-for-command-line-use)
48-
and set it as the env variable `GITHUB_TOKEN`. `github-release` will
49-
automatically pick it up from the environment so that you don't have to
50-
pass it as an argument.
48+
**NOTE**: for these examples I've [created a github token][token] and set it as
49+
the env variable `GITHUB_TOKEN`. `github-release` will automatically pick it up
50+
from the environment so that you don't have to pass it as an argument.
51+
52+
[token]: https://help.github.com/articles/creating-an-access-token-for-command-line-use
5153

5254
```sh
5355
# set your token

0 commit comments

Comments
 (0)