init

1 files changed, 18 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7dcd4de
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+Simple X hotkey daemon, with a `bind` argument
+
+
+The config file is a script that calls `piss bind` commands. Each bind consists of a key combination in quotes.
+
+Config example:
+```sh
+#!/usr/bin/env sh
+piss bind "Super + Return" "st"
+```
+Or alternatively, in Lua:
+```lua 
+#!/usr/bin/env lua
+os.execute('piss bind "Super + Return" "st"')
+```
+
+The daemon automatically detects the shebang and executes your config!
+My config can be seen [here.](pissrc.example.lua)