Skip to content

Commit

Permalink
improve doc
Browse files Browse the repository at this point in the history
  • Loading branch information
ungoldman committed Feb 8, 2015
1 parent 78f185c commit eecfb93
Showing 1 changed file with 19 additions and 9 deletions.
28 changes: 19 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@ ghRelease(options, auth, function (err, result) {

### CLI

Should be run at the root of the project to be released.

Expects a `package.json` and `CHANGELOG.md`.

```
$ npm install -g gh-release
$ gh-release --help
Expand All @@ -57,18 +61,24 @@ Options:

Defaults:

* in `package.json`:
* `version`
* `repository.url`
* in `CHANGELOG.md`:
* changes section matching `version` in `package.json`
* `tag_name`: `v` + `version` from `package.json`
* `target_commitish`: `master` for now
* `name`: `v` + `version` from `package.json`
* `body`: section from `CHANGELOG.md` matching `version` from `package.json`
* `owner`: repo owner parsed out of `repository.url` from `package.json`
* `repo`: repo name parsed out of `repository.url` from `package.json`
* `draft`: false
* `prerelease`: false

Not yet implemented:

* zip and upload dist using `files` array from `package.json`

Optional:
Override defaults with flags (cli) or the `options` object (node).

* in `package.json`:
* (not yet implemented) `files` array containing files to zip & upload w/ release
## Example

Override defaults with flags (cli) or options object (node).
The first release of this module was created using this module: https://github.com/ngoldman/gh-release/releases/tag/v1.0.0

## Reference

Expand Down

0 comments on commit eecfb93

Please sign in to comment.