From 2e1a2f6d8ad20771758049dc680323078898f8b7 Mon Sep 17 00:00:00 2001
From: Akshay <nerdypepper@tuta.io>
Date: Fri, 29 Nov 2019 23:06:10 +0530
Subject: doc

---
 readme.md | 39 +++++++++++++++++++++++++++++++++++++--
 1 file changed, 37 insertions(+), 2 deletions(-)

(limited to 'readme.md')

diff --git a/readme.md b/readme.md
index 0860ed2..f51fd68 100644
--- a/readme.md
+++ b/readme.md
@@ -2,9 +2,44 @@
 
 > cursor location indicator for x11 
 
-a la windows xp
+![preview.gif](screencap.gif)
 
-![preview.png](https://files.nerdypepper.tech/AI.png)
+# install
+
+to build, `xcursorlocate`, you require the `libxcb-devel`
+package.  
+```shell
+$ git clone https://github.com/nerdypepper/xcursorlocate
+$ cd xcursorlocate
+$ cargo install --force --path ./
+```
+
+# usage
+
+have your window manager trigger `xcursorlocate` on a key
+press, i use `sxhkd` to handle key bindings:  
+```shell
+# ~/.config/sxhkd/sxhkdrc
+ctrl + Escape:
+    xcursorlocate
+```
+
+# configuration
+
+`xcursorlocate` is configured via a `.toml` file, which is
+present in `$XDG_CONFIG_HOME/xcursorlocate`. a basic config
+is generated on first run, a sample config can be found in
+the [`examples`](./examples/sample_config.toml) directory.
+
+# uninstall
+
+:(
+
+```
+$ rm -rf xcursorlocate/
+$ rm -rf ~/.config/xcursorlocate/
+$ rm -f $HOME/.cargo/bin/xcursorlocate
+```
 
 # todo:
 
-- 
cgit v1.2.3