|
|
@@ -1,8 +1,13 @@
|
|
|
# Changesets
|
|
|
+[Changesets documentation](https://github.com/changesets/changesets#readme) • [Changesets common questions](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
|
|
|
|
|
|
-Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
|
|
|
-with multi-package repos, or single-package repos to help you version and publish your code. You can
|
|
|
-find the full documentation for it [in our repository](https://github.com/changesets/changesets)
|
|
|
+<br>
|
|
|
|
|
|
-We have a quick list of common questions to get you started engaging with this project in
|
|
|
-[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
|
|
|
+## Commands
|
|
|
+
|
|
|
+| Command | Description |
|
|
|
+| --- | --- |
|
|
|
+| `npx changeset` | Create a changeset. On commit & push, the Actions workflow will create a PR that versions the package and publishes it on merge. |
|
|
|
+| `npx changeset status` | Shows info on the current changesets. |
|
|
|
+| `npx changeset version` | Versions the package and updates the changelog using the previously created changesets. |
|
|
|
+| `npx changeset publish --otp=TOKEN` | Publishes to npm. Should be run after the changes made by `version` are pushed to main. Don't create any commits in between! |
|
Sven