From 7698d59ae70cd8d5cc62aa1e887ca09f15a620c9 Mon Sep 17 00:00:00 2001
From: Oliver Switzer <oliverswitzer@gmail.com>
Date: Mon, 2 Dec 2024 15:07:52 -0500
Subject: [PATCH] chore: update README.md to reflect latest version, and add
 bumping the README version automatically to CI

---
 .github/workflows/publish.yml |  1 +
 CONTRIBUTING.md               | 10 ++++++++++
 README.md                     |  2 +-
 3 files changed, 12 insertions(+), 1 deletion(-)
 create mode 100644 CONTRIBUTING.md

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
index 7ff8616..98215f0 100644
--- a/.github/workflows/publish.yml
+++ b/.github/workflows/publish.yml
@@ -57,6 +57,7 @@ jobs:
 
           # Update version in mix.exs
           sed -i 's/version: ".*"/version: "'${RELEASE_VERSION#v}'"/g' mix.exs
+          sed -i 's/\{:shortcut_api_ex, "*"/\{:shortcut_api_ex, "'${RELEASE_VERSION#v}'"/g' README.md
           git add mix.exs
           git commit -m "chore: Bump version to ${RELEASE_VERSION}"
           git push origin $BRANCH_NAME
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..2c52bff
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,10 @@
+
+## Publishing a new commit
+
+To publish a new version of this tool, run the github CI [publish.yml](.github/workflows/publish.yml).
+
+It will:
+
+* Automatically create a new version based the conventional commits since your last release.
+* Bump the version in the README.md and mix.exs file
+* Create a github release for that version
\ No newline at end of file
diff --git a/README.md b/README.md
index 9a2b0c7..f1e14a6 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,7 @@ by adding `shortcut_api_ex` to your list of dependencies in `mix.exs`:
 ```elixir
 def deps do
   [
-    {:shortcut_api_ex, "~> 0.1.0"}
+    {:shortcut_api_ex, "~> 1.0.0"}
   ]
 end
 ```