From 7f365ec23086f095572fc102b7df51926a4d12e1 Mon Sep 17 00:00:00 2001
From: Chris Badahdah <a.s.badahdah@gmail.com>
Date: Sat, 3 Aug 2019 11:27:05 -0700
Subject: [PATCH] Adds readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..705937d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# klojure
+
+A blueprint bundle for deploying a
+[nrepl](https://nrepl.org/nrepl/0.6.0/index.html) server to a
+[karaf](https://karaf.apache.org/) container.
+
+## building
+
+To build the klojure jar, do:
+
+    mvn clean install
+
+## installing
+
+To install the jar, do:
+
+    cp target/klojure-0.0.1-SNAPSHOT.jar $DDF_HOME/deploy
+
+## running a repl
+
+To run a repl in the karaf console, do:
+
+    clj:repl
+
+To connect to the nrepl server with [lein](https://leiningen.org/), do:
+
+    lein repl :connect 7888
+
+The nrepl server is also available for clients such as
+[cursive](https://cursive-ide.com/) and
+[vim-fireplace](https://github.com/tpope/vim-fireplace).