Skip to content

Commit

Permalink
docs: reorder options, add --chlog, --chash flags
Browse files Browse the repository at this point in the history
chlog - to create changelog.md
chash - to prepend commit hash (with url) in changelog &/or release note
  • Loading branch information
adhocore committed Aug 14, 2018
1 parent c9de526 commit d2c1b21
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,10 +73,12 @@ minor Bumps the <minor> part of semver.
### Options

```
-v --vfile Forces creation of VERSION file.
-c --chlog Forces creation of CHANGELOG.md file.
-h --help Show help information and usage.
-u --update Update please to latest version.
-H --chash Prepends commit hash into log.
-p --public Set scoped npm package for public access.
-u --update Update please to latest version.
-v --vfile Forces creation of VERSION file.
```

### Examples
Expand All @@ -86,12 +88,13 @@ please
please --update
please --vfile
please minor --public
please major --vfile
please major --vfile --chlog
```

#### Note

- If there is `VERSION` file in project root, you dont need `--vfile` flag.
- If there is `CHANGELOG.md` file in project root, you dont need `--chlog` flag.
- If there is `box.json` file in project root, it builds and releases `.phar` too.
- If no scope is given, bumps the `<patch>` part of semver.

Expand Down

0 comments on commit d2c1b21

Please sign in to comment.