Skip to content

Commit

Permalink
docs: add release section
Browse files Browse the repository at this point in the history
  • Loading branch information
ChristiaanScheermeijer committed Dec 9, 2024
1 parent ee37b26 commit 82c818c
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,22 @@ const App: React.FC = () => {
export default App;
```

## Release

To create a release, perform the following steps:

Create a new version using `yarn version`. Follow [semver](https://semver.org/) rules to determine the next version.

When the script completes, a page is automatically opened to create a new GitHub release with all information filled in.

Before creating the GitHub release, the commit and tag must be pushed to GitHub. After doing so, refresh the new
release page so it detects the existing tag. After creating the GitHub release, the version is automatically published
to NPM.

```shell
$ yarn version
```

## Documentation

Run the documentation app, which showcases all features of the TileSlider package:
Expand Down

0 comments on commit 82c818c

Please sign in to comment.