From ad70872013bfad5f191db3c583875edfcb3e3482 Mon Sep 17 00:00:00 2001
From: Thomas Kluyver <takowl@gmail.com>
Date: Thu, 26 Jun 2014 17:29:02 -0700
Subject: [PATCH] Add README

---
 README.rst | 12 ++++++++++++
 1 file changed, 12 insertions(+)
 create mode 100644 README.rst

diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..6824169
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,12 @@
+A simple IPython kernel for bash
+
+This requires IPython 3, which is not yet released.
+
+To test it, install with ``setup.py``, then::
+
+    ipython qtconsole --kernel bash
+
+For details of how this works, see IPython's docs on `wrapper kernels
+<http://ipython.org/ipython-doc/dev/development/wrapperkernels.html>`_, and
+Pexpect's docs on the `replwrap module
+<http://pexpect.readthedocs.org/en/latest/api/replwrap.html>`_