From 157d83da62d0ac5734a1cc07d3ac0632c1657895 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sebasti=C3=A1n=20Zaffarano?= <sebas@zaffarano.com.ar>
Date: Sun, 26 Jan 2025 18:42:15 +0100
Subject: [PATCH] docs: Update readme

---
 README.md | 41 ++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 40 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 676ec4c..b57f671 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@
 ![Release](https://github.com/szaffarano/rofi-tools/actions/workflows/release.yml/badge.svg)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
 
-Note: Only tested with [rofi-wayland](https://github.com/lbonn/rofi) although
+Note: Only tested with [rofi-wayland](https://github.com/lbonn/rofi), although
 it should work with the [official version](https://github.com/davatorium/rofi).
 
 ## Cliphist integration
@@ -20,6 +20,45 @@ images, neither the `script` mode nor a custom mode/plugin were valid options
 because it's impossible to dynamically update the layout without re-launching
 Rofi (more info [here](https://github.com/davatorium/rofi/issues/1356)).
 
+### Usage
+
+Just build the tool or download the [latest
+release](https://github.com/szaffarano/rofi-tools/releases) and add the binary
+to your path.
+
+It's also exposed as a Nix flake. Add the input to your `flake.nix`
+
+```nix
+{
+  inputs = {
+    wofi-tools = {
+      url = "github:szaffarano/rofi-tools";
+      inputs = {
+        nixpkgs.follows = "nixpkgs";
+      };
+    };
+  }
+}
+```
+
+And reference the package as usual, e.g.,
+
+```nix
+home.packages = [
+  inputs.rofi-tools.packages.${pkgs.system}.rofi-cliphist
+];
+```
+
+And finally call it
+
+```bash
+path/to/cliphist-rofi
+```
+
+It will show by default all non-binary cliphist entries. You can switch between
+text/image mode by using `Alt-t` / `Alt-i` and also delete entries using
+`Alt-d`.
+
 ![Text Mode](./img/text-mode.png)
 
 ![Image Mode](./img/img-mode.png)