Skip to content

Commit

Permalink
docs: ditch demo.png, update CLI example
Browse files Browse the repository at this point in the history
  • Loading branch information
ungoldman committed Apr 4, 2022
1 parent 03b352b commit b626f4a
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 13 deletions.
1 change: 0 additions & 1 deletion .npmignore
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
rocket.png
demo.png
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,6 @@ Create a release for a node package on GitHub.
- Defaults to using information from `package.json` and `CHANGELOG.md`.
- Supports uploading release assets.

<div align="center">

<img src="./demo.png" width="690" height="540" alt="example CLI output">

</div>

## Install

```
Expand All @@ -45,17 +39,23 @@ $ gh-release
Your GitHub username: ungoldman
Your GitHub password: βœ”βœ”βœ”βœ”βœ”βœ”βœ”βœ”

creating release v1.0.0 for ungoldman/cool-project
creating release v1.0.9 for ungoldman/gh-release-test

name: v1.0.0
tag_name: v1.0.0
target_commitish: 9561804a4d1fca2525d3207bec4907dd5ec7a705
name: v1.0.9
tag_name: v1.0.9
target_commitish: 3b06705e43be83363f063966f36ede3990a2842a
endpoint: https://api.github.com
body:

* engage
### Maintenance
* test: testing latest CLI output
* deps: gh-release@6
* pkg: set package to private
* pkg: update repo URLS
* misc: ignore package-lock.json

? publish release to github? Yes
https://github.com/ungoldman/cool-project/releases/tag/v1.0.0
https://github.com/ungoldman/gh-release-test/releases/tag/v1.0.9
```

Should be run at the root of the project to be released.
Expand Down
Binary file removed demo.png
Binary file not shown.

0 comments on commit b626f4a

Please sign in to comment.