diff --git a/.DS_Store b/.DS_Store index ca2b787..d09f88f 100644 Binary files a/.DS_Store and b/.DS_Store differ diff --git a/README.md b/README.md index 0df4a08..3b31028 100644 --- a/README.md +++ b/README.md @@ -119,11 +119,12 @@ contribute just follow these steps: ## Publishing -To publish run: - -```sh -# This needs to be run with "npm run" and not "yarn" -# See: https://github.com/sindresorhus/np/issues/432#issuecomment-583732143 -# We could set the publishConfig correctly, but using NPM is good enough -npm run publish-new-version -``` +To release a new version follow these steps: + +1. `git checkout master && git pull` - ensure you are on the "master" branch with latest changes +2. `yarn version` - choose "x.y.z" as the version to be released +3. `git show` - verify the changes of the version commit +4. `yarn build` - only build the package after the "yarn version" command so the bundled + "package.json" uses the updated version +5. `yarn publish --access public` +6. `git push --follow-tags` - to push the commits to a "main" branch diff --git a/docs/index.html b/docs/index.html index f134a43..99902bd 100644 --- a/docs/index.html +++ b/docs/index.html @@ -123,9 +123,16 @@
To publish run:
-# This needs to be run with "npm run" and not "yarn"
# See: https://github.com/sindresorhus/np/issues/432#issuecomment-583732143
# We could set the publishConfig correctly, but using NPM is good enough
npm run publish-new-version
-
+To release a new version follow these steps:
+git checkout master && git pull
- ensure you are on the "master" branch with latest changesyarn version
- choose "x.y.z" as the version to be releasedgit show
- verify the changes of the version commityarn build
- only build the package after the "yarn version" command so the bundled
+"package.json" uses the updated versionyarn publish --access public
git push --follow-tags
- to push the commits to a "main" branch