adds release info

README.md

@@ -132,10 +132,16 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/revelr
 
 Everyone is welcome to participate in the project. We expect contributors to adhere to the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md).
 
+## Releases
+
+See [RELEASES.md](RELEASES.md) for details about the release process.
+
+
 ## Acknowledgments
 
 Special thanks to the creators of Langchain for their initial approach to recursive text splitting, which inspired this library. See the [NOTICE](NOTICE) file for details.
 
+
 ## License
 
 TextChunker is released under the MIT License. See the [LICENSE](LICENSE) file for details.

RELEASES.md

@@ -0,0 +1,11 @@
+# Releasing a new version
+
+## Preparation
+- [ ] Update the package version in `mix.exs`
+- [ ] Update `CHANGELOG.md` to describe the new changes
+- [ ] Update the package version badge and installation instructions in `README.md`
+
+## Release Process
+- [ ] Make sure all changes in the `Preparation` section are in `main`
+- [ ] In GitHub, create, and publish, a new release with appropriate notes, and version matching the package version `mix.exs`
+- [ ] The github actions workflow should automatically publish the package and docs to hex

mix.exs

@@ -53,6 +53,7 @@ defmodule TextChunker.MixProject do
       extras:
         [
           "CODE_OF_CONDUCT.md",
+          "RELEASES.md",
           "CONTRIBUTING.md",
           "README.md",
           "LICENSE",