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

---
 examples/sample_config.toml |   9 +++++----
 readme.md                   |  39 +++++++++++++++++++++++++++++++++++++--
 screencap.gif               | Bin 0 -> 294901 bytes
 3 files changed, 42 insertions(+), 6 deletions(-)
 create mode 100644 screencap.gif

diff --git a/examples/sample_config.toml b/examples/sample_config.toml
index fdf2883..6b906be 100644
--- a/examples/sample_config.toml
+++ b/examples/sample_config.toml
@@ -11,13 +11,14 @@ duration = 500
 # the width of each circle in display pixels.
 thickness = 1
 
-# total circles displayed in the indicator. setting this to a value greater
-# than max_size/thickness could lead to the indicator not being drawn at all.
-no_of_circles = 7
+# number of frames in the animation
+# could result in choppy animations if you set it very high
+# (it can't draw 200 frames in 500 millis dude)
+framerate = 30
 
 # indicator color, set to hex (0xRRGGBB) or 32 bit int.
 # alpha not supported (yet)
 color = 0x00FECA
 
-# values: Grow, Shrink
+# values: Grow, Shrink, GrowOutline, ShrinkOutline
 animation = 'Shrink'
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:
 
diff --git a/screencap.gif b/screencap.gif
new file mode 100644
index 0000000..12b5d62
Binary files /dev/null and b/screencap.gif differ
-- 
cgit v1.2.3