Skip to content

Commit

Permalink
Add publish entry to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Rico Herwig committed Feb 9, 2021
1 parent cf20d15 commit fff7d48
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,18 @@ This error is known to be caused by an empty `.eslintignore` file.
To solve this, either make sure that your `.eslintignore` contains at
least one entry or is removed entirely.

## Publishing
In order to publish a new version of this package on npm, follow
these steps:

1. Bump the version field inside the [package.json](package.json)
2. Create an entry inside the [CHANGELOG.md](CHANGELOG.md)
3. Push your code to `main`
4. Tag your commit with the respective version
5. Create a Github release

Now, Github Actions will build and publish the new version on npm.

## Changelog
This project adheres to [Semantic Versioning](https://semver.org/).
Please refer to the [CHANGELOG.md](CHANGELOG.md) for detailed changes and
Expand Down

0 comments on commit fff7d48

Please sign in to comment.