Skip to content

Commit 64c629d

Browse files
committed
Update README.md
1 parent 9ca33b1 commit 64c629d

1 file changed

Lines changed: 29 additions & 6 deletions

File tree

README.md

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,20 @@
22

33
[![NPM](https://nodei.co/npm/github-release-cli.png?downloads=true&stars=true)](https://www.npmjs.com/package/github-release-cli)
44

5-
A command-line tool for uploading release assets to a GitHub repository.
5+
A command-line tool for managing release assets on a GitHub repository.
66

77
## Installation
88

99
```
1010
npm install -g github-release-cli
1111
```
1212

13-
1413
## Command Line Usage
1514

1615
Run `github-release` with `-h` or `--help` options:
1716

1817
```
19-
Usage: github-release [options] [file ...]
18+
Usage: github-release <command> [<args>]
2019
2120
Options:
2221
@@ -30,6 +29,30 @@ Options:
3029
-b, --body <body> body
3130
```
3231

32+
### Upload
33+
34+
```
35+
$ github-release upload \
36+
--owner cheton \
37+
--repo github-release-cli \
38+
--tag "v0.1.0" \
39+
--name "v0.1.0" \
40+
--body "This release contains bug fixes and imporvements, including:\n..." \
41+
archive.zip index.html app.min.css app.min.js
42+
```
43+
44+
### Delete
45+
46+
You can use glob expressions to match files:
47+
```
48+
$ github-release delete \
49+
--owner cheton \
50+
--repo github-release-cli \
51+
--tag "v0.1.0" \
52+
--name "v0.1.0" \
53+
archive.zip index.html "app.*"
54+
```
55+
3356
## Examples
3457

3558
https://github.com/cncjs/cncjs/blob/master/.travis.yml
@@ -73,14 +96,14 @@ Now you're ready to upload assets to a GitHub repository from a CI server. For e
7396

7497
```
7598
COMMIT_LOG=`git log -1 --format='%ci %H %s'`
76-
github-release \
99+
github-release upload \
77100
--owner=cheton \
78101
--repo=github-release-cli \
79102
--tag="latest" \
80103
--name="${TRAVIS_BRANCH}" \
81104
--body="${COMMIT_LOG}" \
82-
"releases/file.zip" \
83-
"releases/file.tar.gz"
105+
"releases/myapp-0.1.0-win-x32.exe" \
106+
"releases/myapp-0.1.0-win-x64.exe"
84107
```
85108

86109
If you're using Travis CI, you may want to encrypt environment variables:

0 commit comments

Comments
 (0)