aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCody Logan <cody@lokken.dev>2023-11-27 15:58:27 -0800
committerCody Logan <cody@lokken.dev>2023-11-27 15:58:27 -0800
commit2de662aec9fb17cd0fc3d91206d7137b5782303a (patch)
tree2e158bbab3aad746f8a794ae6c0047afbc1565e9
parent037c44d94262bee77f8eef4ab71d16b1c492da01 (diff)
downloadconvert-markdown-2de662aec9fb17cd0fc3d91206d7137b5782303a.tar.gz
convert-markdown-2de662aec9fb17cd0fc3d91206d7137b5782303a.zip
Add README
-rw-r--r--README.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..29d5d88
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# convert-markdown
+
+Simple Markdown to HTML converter using lowdown_file(3).
+
+## Usage
+
+```console
+$ convert-markdown
+# header
+hello **world**
+[Ctrl-D]
+<h1 id="header">header</h1>
+
+<p>hello <strong>world</strong></p>
+```
+
+```console
+$ convert-markdown < README.md
+<h1 id="convert-markdown">convert-markdown</h1>
+
+<p>Simple Markdown to HTML converter using lowdown_file(3).</p>
+
+<h2 id="Usage">Usage</h2>
+
+<pre><code class="language-console">$ convert-markdown
+# header
+hello **world**
+[Ctrl-D]
+&#60;h1 id="header"&#62;header&#60;&#47;h1&#62;
+
+&#60;p&#62;hello &#60;strong&#62;world&#60;&#47;strong&#62;&#60;&#47;p&#62;
+</code></pre>
+```
+
+## License
+
+[ISC](https://opensource.org/license/isc-license-txt/)