chore: update README.md to reflect latest version, and add bumping th…

…e README version automatically to CI

.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

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

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
 ```