docs: Update README

Author: glitch452

README.md

@@ -16,52 +16,69 @@ you'll need to configure that workflow yourself. You can look to the
 
 - Check for the latest version number published to npm.
 - Lookup all commits between the git commit that triggered the action and the latest publish.
-  - If the package hasn't been published or the prior publish does not include a git hash, we'll
-    only pull the commit data that triggered the action.
-- Based on the commit messages, increment the version from the lastest release.
-  - If the strings "BREAKING CHANGE" or "!:" are found anywhere in any of the commit messages or descriptions the major
-    version will be incremented.
-  - If a commit message begins with the string "feat" then the minor version will be increased. This works
-    for most common commit metadata for feature additions: `"feat: new API"` and `"feature: new API"`.
+  - Note: The package needs to have an initial publish in order to pull the package details.
+- Based on the commit messages, increment the version from the latest release.
+  - If the strings "BREAKING CHANGE" is found anywhere in any of the commit messages, or "!:" is found in the first line or a commit message starts with one of the provided major tags (optional), then the major version will be incremented.
+  - If a commit message begins with the string "feat" (or a tag in the minor tags list) then the minor version will be increased. This works for most common commit metadata for feature additions: `"feat: new API"` and `"feature: new API"`.
   - All other changes will increment the patch version.
-- Publish to npm using the configured token.
+- Publish to npm (or the provided registry url) using the configured token.
 - Push a tag for the new version to GitHub.
 
 ### Configuration
 
-You can configure some aspects of merge-release action by passing some environmental variables.
+You can configure some aspects of merge-release action by using the `with` properties on the action or passing some environmental variables.
 
 - **GITHUB_TOKEN (required)**
   - Github token to allow tagging the version.
 - **NPM_AUTH_TOKEN (required)**
-  - NPM Auth Token to publish to NPM, read [here](https://docs.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) how to setup it as a secret.
+  - NPM Auth Token to publish to the registry, read [here](https://docs.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) how to setup it as a secret.
 - **DEPLOY_DIR**
-  - The path where the dist `package.json` is to run npm publish. Defaults to the root dir.
+  - The path where the dist `package.json` is to run npm publish. Defaults to the root dir. This is a relative file path, relative to the root of the repo.
 - **SRC_PACKAGE_DIR**
-  - The path where the src package.json is found. Defaults to the root dir.
+  - The path where the src `package.json` is found. Defaults to the root dir. This is a relative file path, relative to the root of the repo.
 - **NPM_REGISTRY_URL**
-  - NPM Registry URL to use. defaults to: `https://registry.npmjs.org/`
+  - NPM Registry URL to use. defaults to: `https://registry.npmjs.org/`. Set it to `https://npm.pkg.github.com` for GitHub Packages.
 - **NPM_PRIVATE**
   - If you wish privately publish your package please ensure you have set this to `true`
+- **DISABLE_GIT_TAG**
+  - If you wish to skip setting the git tag, set this to `true`
+- **MAJOR_TAGS**
+  - A list of tags to check for when considering whether to perform a major version update. The value is a list separated by the `|` character. i.e. `major|my-major-tag`
+- **MINOR_TAGS**
+  - Override the list of tags to check for when considering whether to perform a minor version update. The value is a list separated by the `|` character. i.e. `feat|minor|my-minor-tag`
 
-`merge-release` will use `npm publish` unless you've defined a `publish` script in your `package.json`.
+Note: `merge-release` will use `npm publish` by default; but if you've defined a `publish` script in your `package.json` it will use that instead.
+
+## Examples
 
 ```yaml
-- uses: Github-Actions-Community/merge-release@main
-  env:
+- name: Publish to NPM
+  uses: Github-Actions-Community/merge-release@main
+  with:
     GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
     DEPLOY_DIR: my/deploy/dir
     SRC_PACKAGE_DIR: my/src/package
 ```
 
+```yaml
+- name: Publish to GitHub Packages
+  uses: Github-Actions-Community/merge-release@main
+  with:
+    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    NPM_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    NPM_REGISTRY_URL: https://npm.pkg.github.com/
+    MINOR_TAGS: feat|docs
+```
+
 ## Contributors ✨
 
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
 
-<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
 <!-- prettier-ignore-start -->
 <!-- markdownlint-disable -->
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+
 <table>
   <tbody>
     <tr>
@@ -73,11 +90,10 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
   </tbody>
 </table>
 
+<!-- ALL-CONTRIBUTORS-LIST:END -->
 <!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->
 
-<!-- ALL-CONTRIBUTORS-LIST:END -->
-
 This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
 
 ##### Created my free [logo](https://logomakr.com/5sISSS) at [LogoMakr.com](LogoMakr.com)