summaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown
new file mode 100644
index 0000000..42afa23
--- /dev/null
+++ b/README.markdown
@@ -0,0 +1,13 @@
+# simplechat
+
+A simple websocket-based chatserver written in Go.
+
+## Installation
+
+`go get github.com/kch42/simplechat`
+
+You will also need the [jQuery](http://jquery.com) library. Download the minified version from <http://jquery.com/download/> and save it as `static/jquery.min.js`
+
+## You are also free to use my public installation
+
+[chat.kch42.net](http://chat.kch42.net)