docs: Add README

414owen · Nov 12, 2023 · c851c1a · c851c1a
1 parent f6f0495
commit c851c1a
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,20 @@
+# pandoc-builder-monadic
+
+This module provides a monadic DSL for constructing Pandoc documents.
+
+
+```haskell
+import Text.Pandoc.Builder.Monadic
+
+myDoc :: Pandoc
+myDoc = doc $ do
+  h1 "Work log"
+  para $ do
+    kv "month" "2023-10"
+    emph $ str k
+    str ": "
+    linebreak
+  para $ do
+    code "Wow, such code!"
+    code "It's a monoid too" <> strong "'cos why not"
+```