first draft

1 files changed, 12 insertions, 0 deletions

diff --git a/README.md b/README.md
index c31ae4d..7fafc49 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,15 @@
 
 An un-inventively named quick script to process markdown documents, executing
 in-line SQL statements against a sqlite database.
+
+You write a markdown file with code tagged `sql`, then run this script against
+it, along with a local sqlite3 database file, and you get HTML output with the
+query results in table form. Sort of like a crude/simple jupyter notebook.
+
+Requires the python package `mistune`. Try something like:
+
+    # debian/ubuntu
+    sudo apt install python3-mistune
+
+    # elsewhere
+    sudo pip3 install mistune