diff --git a/README.md b/README.md index 05eac13..1ace59c 100644 --- a/README.md +++ b/README.md @@ -20,18 +20,29 @@ Usage: github-release [] Options: -V, --version output the version number --baseurl API endpoint (default: "https://api.github.com") - -T, --token OAuth2 token - -o, --owner The repository owner. - -r, --repo The repository name. + -T, --token OAuth2 token (default: null) + -o, --owner The repository owner. (default: "") + -r, --repo The repository name. (default: "") -t, --tag The name of the tag. + --release-id The release id. -c, --commitish Specifies the commitish value for tag. Unused if the tag already exists. - -n, --name The name of the release. + -n, --name The name of the release. (default: "") -b, --body Text describing the contents of the tag. -d, --draft [value] `true` makes the release a draft, and `false` publishes the release. -p, --prerelease [value] `true` to identify the release as a prerelease, `false` to identify the release as a full release. -h, --help output usage information ``` +## Commands + +### List + +```sh +github-release list + --owner cheton \ + --repo github-release-cli +``` + ### Upload ```sh @@ -82,16 +93,35 @@ github-release upload \ ### Delete +#### Delete release assets + You can use glob expressions to match files: ```sh github-release delete \ --owner cheton \ --repo github-release-cli \ --tag "v0.1.0" \ - --name "v0.1.0" \ archive.zip index.html "app.*" ``` +#### Delete a release by specifying the tag name + +```sh +github-release delete \ + --owner cheton \ + --repo github-release-cli \ + --tag "v0.1.0" +``` + +#### Delete a release by specifying the release id + +```sh +github-release delete \ + --owner cheton \ + --repo github-release-cli \ + --release-id 17994985 +``` + ## Examples https://github.com/cncjs/cncjs-pendant-tinyweb/blob/master/.travis.yml