commit daf51240a0e3d3328842a7314eb375b29d0ae8a8 (patch)
parent 9dd4642bc4c9111d1d58f506f5065125c9e858ed
Author: Alex Karle <alex@alexkarle.com>
Date: Mon, 27 Dec 2021 15:51:20 -0500
Document "streaming" nature of parsing
Diffstat:
1 file changed, 7 insertions(+), 2 deletions(-)
diff --git a/README b/README
@@ -1,4 +1,4 @@
-# nihdoc
+# `nihdoc`
Not Invented Here Doc
- - - ---
@@ -10,13 +10,18 @@
## Description
-nihdoc is my take at a light markup language to improve my
+`nihdoc` is my take at a light markup language to improve my
time-to-publish on blog posts. I concede up front that others
should likely use markdown, which is both prettier and more
well-known, but as a personal challenge I try to keep my blog
publishable under *only the OpenBSD base system*. Since there's
no markdown parser in base, I had to write my own!
+Probably the most interesting feature is that it's is a streaming
+parser using only constant space. In other words, it only reads
+the input once, never scans, and doesn't store the input in
+memory. You can see this if you run it interactively: `cat | nihdoc`.
+
## Usage
`nihdoc` reads from stdin and prints HTML snippets to stdout. No
