Skip to content

Commit

Permalink
docs ~ (README) usage and package/publish instruction polish
Browse files Browse the repository at this point in the history
  • Loading branch information
rivy committed Oct 4, 2023
1 parent 800c5b9 commit db39b5b
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -421,7 +421,7 @@ yarn --immutable --immutable-cache --check-cache
```shell
> npm run help
...
usage: `npm run TARGET` or `npx run-s TARGET [TARGET..]`
Usage: `npm run TARGET` or `npx run-s TARGET [TARGET..]`

TARGETs:

Expand Down Expand Up @@ -486,7 +486,10 @@ git commit --amend --no-edit
git tag -f "v${VERSION}"
# (optional) prerelease checkup
npm run prerelease
#=== * WinOS
```
```shell
@rem #=== * WinOS
@rem # update project VERSION strings (package.json,...)
@rem # * `bmp --[major|minor|patch]`; next VERSION in M.m.r (semver) format
bmp --minor
Expand Down Expand Up @@ -515,9 +518,8 @@ npm run prerelease
##### Publish
```shell
# publish
# * optional (will be done in 'prePublishOnly' by `npm publish`)
npm run clean && npm run test && npm run dist && git-changelog > CHANGELOG.mkd #expect exit code == 0
npm run clean && npm run test && npm run dist && git-changelog > CHANGELOG.mkd # expect exit code == 0
git diff-index --quiet HEAD || echo "[lint] ERROR uncommitted changes" # expect no output and exit code == 0
# *
npm publish # `npm publish --dry-run` will perform all prepublication actions and stop just before the actual publish push
Expand Down

0 comments on commit db39b5b

Please sign in to comment.