diff --git a/README.md b/README.md index 8c2b4b2..c48becd 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ ## Plugins -This shareable configuration use the following plugins: +This [shareable configuration](https://github.com/jedmao/semantic-release-npm-github-config/blob/master/.releaserc.json) uses the following plugins: - [`@semantic-release/commit-analyzer`](https://github.com/semantic-release/commit-analyzer) - [`@semantic-release/release-notes-generator`](https://github.com/semantic-release/release-notes-generator) @@ -15,6 +15,14 @@ This shareable configuration use the following plugins: - [`@semantic-release/github`](https://github.com/semantic-release/github) - [`@semantic-release/git`](https://github.com/semantic-release/git) +## Summary + +- Provides an informative [git](https://github.com/semantic-release/git) commit message for the release commit that does not trigger continuous integration and conforms to the [conventional commits specification](https://www.conventionalcommits.org/) (e.g., "chore(release): 1.2.3 [skip ci]\n\nnotes"). +- Creates a tarball that gets uploaded with each [GitHub release](https://github.com/semantic-release/github). +- Publishes the same tarball to [npm](https://github.com/semantic-release/npm). +- Commits the version change in `package.json`. +- Creates or updates a [changelog](https://github.com/semantic-release/changelog) file. + ## Install ```bash