aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 9 insertions, 6 deletions
diff --git a/README.md b/README.md
index 7fafc49..1b3ada2 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,15 @@
-An un-inventively named quick script to process markdown documents, executing
-in-line SQL statements against a sqlite database.
+# sqlite-notebook
-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.
+An un-inventively named quick script to process markdown documents with inline
+SQL queries.
-Requires the python package `mistune`. Try something like:
+You write a markdown file with code blocks 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` to parse markdown. Try something like:
# debian/ubuntu
sudo apt install python3-mistune