From 8d4d7091ff9b5d072bdb9ad53eedba1b7b0ec770 Mon Sep 17 00:00:00 2001
From: Spencer Young <spencer.young@spyoung.com>
Date: Wed, 21 Nov 2018 22:31:58 -0800
Subject: [PATCH] add readme

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

diff --git a/README.md b/README.md
index e69de29b..daabc6b1 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,37 @@
+# ahk
+
+A (proof-of-concept) Python wrapper around AHK.
+
+# Usage
+
+```python
+from ahk import AHK
+ahk = AHK()
+ahk.move_mouse(x=100, y=100, speed=10)  # blocks until mouse finishes moving
+print(ahk.mouse_position)  #  (100, 100)
+```
+
+# Installation
+
+```
+pip install ahk
+```
+
+## Dependencies
+
+Just the AHK executable. It's expected to be on PATH by default. 
+
+Alternatively you can set an `AHK_PATH` environment variable. 
+
+Or, provide it inline
+
+```python
+from ahk import AHK
+ahk = AHK(executable_path=r'C:\ProgramFiles\AutoHotkey\AutoHotkey.exe')
+```
+
+# Development
+
+Right now this is just an idea. It may not even be a particularly good one.
+
+Not much is implemented right now, but the vision is to provide additional interfaces that mirror the core functionality from the AHK API in a Pythonic way.
\ No newline at end of file