# HG changeset patch
# User telesto
# Date 1418654648 -3600
#      Mon Dec 15 15:44:08 2014 +0100
# Node ID 79c17d3d5a2ae9cc4a9ce45d335f0f8b3580ca45
# Parent  50f9f42a36fefb862279e2b87c496ea516b63ad8
added README

diff --git a/README.md b/README.md
new file mode 100644
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+hackurist
+=========
+[hackurist](https://bitbucket.com/telesto/hackurist) is made up of a client library and a client command line program to access a running [dfhack](https://github.com/DFHack/dfhack) rpc server. It is written in [Go](http://golang.org/). 
+
+client library
+--------------
+Installation:
+
+	go get bitbucket.org/telesto/hackurist
+
+API Documentation: (http://godoc.org/bitbucket.org/telesto/hackurist)
+
+
+command line tool
+-----------------
+The command line tool is similar to dfhack-run.
+
+Installation:
+
+	go get bitbucket.org/telesto/hackurist/cmd/hackurist
+
+Usage: See
+
+	hackurist -h
+
+Discussion/Contact
+------------------
+todo