Merge pull request #3 from Intentface/latenssi/add-readme

Add initial readme
Intentface · Sep 5, 2024 · c6f8b30 · c6f8b30
2 parents c848e9a + 8a882a8
commit c6f8b30
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/.changeset/shy-tools-whisper.md b/.changeset/shy-tools-whisper.md
@@ -0,0 +1,5 @@
+---
+"@intentface/react-speech-recognition": patch
+---
+
+Add initial readme
diff --git a/README.md b/README.md
@@ -0,0 +1,13 @@
+# @intentface/react-speech-recognition
+
+## Dev
+
+### Doing a release
+
+After finishing your feature normally, to automatically bump version number, update changelog and do an npm release:
+
+1.  `npm run add-change`
+2.  Follow the instructions
+3.  Commit the changeset file(s) to your feature branch and push to Github
+4.  Create a PR normally, including the changeset file(s)
+5.  Eventually accept the PR called "Version Packages" created by the changeset bot