📝 install instructions, badges and todo

.github/workflows/release.yml

@@ -38,7 +38,7 @@ jobs:
         run: ./debian-build.sh
 
       - name: Commit & Push changes
-        uses: actions-js/push@master
+        uses: actions-js/push@master@v1.4
         with:
           message: "🔖 auto update version 🤖"
           github_token: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -1,5 +1,9 @@
 # Caps Lock Auto Switch
 
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/ad2ien/caps-lock-auto-switch/release.yml?label=release&logo=github&branch=main)
+![License](https://img.shields.io/badge/license-GPL%202%2B%202.0-blue.svg)
+![Gitmoji](https://img.shields.io/badge/gitmoji-%20%F0%9F%98%9C%20%F0%9F%98%8D-FFDD67.svg)
+
 Use case : as any boomer, I sometimes type while looking at the keyboard. And I end up starting sentences having the case all wrong.
 
 This small service listens to keyboard events and detects words like `hELLO `. Then the caps lock is toggled and the word is retyped.
@@ -9,6 +13,17 @@ This package is written in Rust and uses [rdev](https://docs.rs/rdev/latest/rdev
 > [!WARNING]  
 > 🚧 Debian package under construction
 
+## Install
+
+Run the following commands to install the package:
+
+```bash
+VERSION=$(curl "https://api.github.com/repos/ad2ien/caps-lock-auto-switch/tags" | jq -r '.[0].name')
+curl -L "https://github.com/ad2ien/caps-lock-auto-switch/releases/download/${VERSION}/capslock-auto-switch_${VERSION#v}-1_all.deb -o capslock-auto-switch_${VERSION#v}-1_all.deb"
+sudo dpkg -i capslock-auto-switch_${VERSION#v}-1_all.deb
+rm capslock-auto-switch_${VERSION#v}-1_all.deb
+```
+
 ## Dev
 
 Pre requisites:
@@ -40,20 +55,15 @@ Only tried on Pop!_OS 22.04 LTS. Should work on any Debian based distri with X11
 - [x] uninstall should remove service
 - [x] config file for a debian package?
 - [x] man page
-- [ ] release
-  - [ ] write changelog and commit
-  - [ ] create release / tag. CI does:
-    - [ ] replace versions with tag name : Cargo.toml, in debian script
-    - [ ] bot commit
-    - [ ] build and set deb as asset
 - [ ] CI lint
-- [ ] install instructions
-- [ ] readme badges
+- [ ] debian package lint warnings
+- [ ] remove test from build script
+- [ ] readme badges rust & lint
 - [ ] commands : help, edit configuration...
 - [ ] check install/remove, upgrade on a clean system
-- [ ] only define project variable once : description version..
+- [ ] only define project variable once : description licence version..
 - [ ] manage languages special characters
-- [ ] debian package lint warnings
 - [ ] dockerize build
 - [ ] logs
 - [ ] docker image project for dch
+- [ ] Have a debian repository to enable `apt-get install capslock-auto-switch`