Skip to content

Commit

Permalink
docs: add new options in usage and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
adhocore committed Mar 3, 2021
1 parent d1a8663 commit 46d6a95
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ please [Scope|Command] [Options]
```

```
please v0.9.0 | (c) Jitendra Adhikari | please is semver release made easy.
please v0.11.0 | (c) Jitendra Adhikari | please is semver release made easy.
Usage: please [command|scope] [--options]
Expand All @@ -88,8 +88,11 @@ Options:
-H --chash Prepends commit hash into log.
-o --organize Commit types as CSV for changelog or release notes.
(Default: feat,fix,refactor,perf,docs,infra,chore)
-L | --label Set custom release label.
-N | --no-sync Do not sync the DEPLOY_BRANCH with remote (faster but unsafe).
-p --public Set scoped npm package for public access.
-u --update Update _please to latest version.
--prev-version Fix the previous version (skips API call).
-u --update Update please to latest version.
-v --vfile Forces creation of VERSION file.
-V --version Forces the exact version to be released.
-y --yes Assume yes for any confirmation.
Expand Down
3 changes: 3 additions & 0 deletions please
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,10 @@ $(ok Options:)
$(info "-H --chash") $(comment "Prepends commit hash into log.")
$(info "-o --organize") $(comment "Commit types as CSV for changelog or release notes.")
$(comment "(Default: feat,fix,refactor,perf,docs,infra,chore)")
$(info "-L | --label") $(comment "Set custom release label.")
$(info "-N | --no-sync") $(comment "Do not sync the DEPLOY_BRANCH with remote (faster but unsafe).")
$(info "-p --public") $(comment "Set scoped npm package for public access.")
$(info "--prev-version") $(comment "Fix the previous version (skips API call).")
$(info "-u --update") $(comment "Update $PLIZ to latest version.")
$(info "-v --vfile") $(comment "Forces creation of VERSION file.")
$(info "-V --version") $(comment "Forces the exact version to be released.")
Expand Down

0 comments on commit 46d6a95

Please sign in to comment.