Skip to content

Commit

Permalink
docs: Update a few references to the old package name that were missed
Browse files Browse the repository at this point in the history
  • Loading branch information
TimothyJones committed Aug 11, 2022
1 parent e613b4c commit 9013459
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ You can override both [parser](https://github.com/conventional-changelog/convent

```json
{
"standard-version": {
"commit-and-tag-version": {
"writerOpts": {
"commitsSort": false
}
Expand Down Expand Up @@ -330,7 +330,9 @@ If you do not want to have any tag prefix you can use the `-t` flag and provide
### Tag replacement

If you've already run `standard-version` when creating your release, you may want to alter the release content and changelog without bumping the version, by using `standard-version --skip.bump`. By default, tagging with an already existing tag make `git` fails. You can add the `--tag-force` flag to make use of `-f` option when calling `git tag`, then the existing version tag will be replaced.
If you've already run `commit-and-tag-version` when creating your release, you may want to alter the release content and changelog without bumping
the version, by using `commit-and-tag-version --skip.bump`. By default, tagging with an already existing tag make `git` fails.
You can add the `--tag-force` flag to make use of `-f` option when calling `git tag`, then the existing version tag will be replaced.

### CLI Help

Expand All @@ -344,11 +346,11 @@ commit-and-tag-version --help
## Code Usage

```js
const standardVersion = require("commit-and-tag-version");
const commitAndTagVersion = require("commit-and-tag-version");

// Options are the same as command line, except camelCase
// standardVersion returns a Promise
standardVersion({
// commitAndTagVersion returns a Promise
commitAndTagVersion({
noVerify: true,
infile: "docs/CHANGELOG.md",
silent: true,
Expand Down

0 comments on commit 9013459

Please sign in to comment.