diff --git a/README.md b/README.md index d3d9a4d..5e9967f 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,14 @@ A small commandline app written in Go that allows you to easily create and delete releases of your projects on Github. In addition it allows you to attach files to those releases. -It interacts with the [github releases API](http://developer.github.com/v3/repos/releases). -Though it's entirely possibly to [do all these things with -cURL](https://github.com/blog/1645-releases-api-preview), It's not -really that user-friendly. For example, you need to first query the API -to find the id of the release you want, before you can upload an -artifact. `github-release` takes care of those little details. +It interacts with the [github releases API][releases-api]. Though it's entirely +possible to [do all these things with cURL][curl], it's not really that +user-friendly. For example, you need to first query the API to find the id of +the release you want, before you can upload an artifact. `github-release` takes +care of those little details. + +[curl]: https://github.com/blog/1645-releases-api-preview +[releases-api]: https://developer.github.com/v3/repos/releases It might still be a bit rough around the edges, pull requests are welcome! @@ -43,11 +45,11 @@ After that you should have a `github-release` executable in your How to use ========== -**NOTE**: for these examples I've [created a github -token](https://help.github.com/articles/creating-an-access-token-for-command-line-use) -and set it as the env variable `GITHUB_TOKEN`. `github-release` will -automatically pick it up from the environment so that you don't have to -pass it as an argument. +**NOTE**: for these examples I've [created a github token][token] and set it as +the env variable `GITHUB_TOKEN`. `github-release` will automatically pick it up +from the environment so that you don't have to pass it as an argument. + +[token]: https://help.github.com/articles/creating-an-access-token-for-command-line-use ```sh # set your token