From 14f115daf0f63d2dce85d1eb24d957524d7341cf Mon Sep 17 00:00:00 2001
From: Teddy Wing
Date: Thu, 22 Nov 2018 19:53:36 +0100
Subject: Add README

---
 README.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..136ea38
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+DomeKey
+=======
+
+DomeKey gives you the power to remap your headphone buttons to any action you
+can think of. Define mappings in text using a Vim-like configuration language.
+
+More information is available on the [website][1].
+
+
+## Install
+
+	$ brew install teddywing/DomeKey/dome-key
+
+
+## Building
+For development:
+
+	$ make build
+	# or
+	$ make run
+	# to build and run the daemon
+
+For release:
+
+	$ make build-release
+
+For distribution:
+
+	$ make pkg
+
+
+## License
+Copyright © 2018 Teddy Wing. Published under a variant of the Open Community
+Indie Software License (see the included LICENSE file).
+
+
+[1]: https://domekey.teddywing.com/
-- 
cgit v1.2.3