From 6c6cbb72ea9577091f1d0d8bd660a1ed7e355121 Mon Sep 17 00:00:00 2001
From: Navid Sassan <navid@sassan.ch>
Date: Tue, 27 Feb 2024 11:38:29 +0100
Subject: [PATCH] update README

---
 Cargo.toml |  2 +-
 README.md  | 39 ++++++++++++++++++++++++++++++++++++++-
 2 files changed, 39 insertions(+), 2 deletions(-)

diff --git a/Cargo.toml b/Cargo.toml
index d131b6b..263a0c2 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -2,7 +2,7 @@
 
 [package]
 name = "bw-menu"
-version = "0.1.0"
+version = "0.1.0-next"
 authors = ["Navid Sassan <navid@sassan.ch>"]
 edition = "2021"
 license = "The Unlicense"
diff --git a/README.md b/README.md
index 1d848e9..bef3569 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,40 @@
 # bw-menu
 
-Bitwarden Menu
\ No newline at end of file
+Bitwarden Menu
+
+## Installation
+```bash
+cat > ~/.cargo/config.toml << 'EOF'
+[registries.gitea]
+index = "https://git.navidsassan.ch/navid.sassan/_cargo-index.git"
+
+[net]
+git-fetch-with-cli = true
+EOF
+cargo add bw-menu --registry gitea
+
+~/.cargo/bin/bw-menu --version
+
+# install dependency
+sudo dnf install rofi
+
+# start bw serve
+export BW_SESSION="$(bw unlock --raw)" && bw serve --hostname 127.0.0.1&
+
+
+# get dropdown (takes a second)
+bw-menu select
+
+# get password of last selected entry
+bw-menu history get 0 password
+
+# list 5 last selected entries (currently saved in `/tmp`)
+bw-menu history list
+```
+
+## Known Issues
+
+* The collections of entries that are in multiple collections are not displayed correctly
+* The history is reset after every reboot if `/tmp` is not persistent
+
+A re-write in Python is planned, during which these issues will be fixed.