From f21363103bf296d87ea78a6e0fbfb2caed4c195c Mon Sep 17 00:00:00 2001
From: Cody Logan <cody@lokken.dev>
Date: Mon, 27 Nov 2023 16:18:39 -0800
Subject: Update README

---
 README.md | 38 ++++++++++++++++++++------------------
 1 file changed, 20 insertions(+), 18 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 29d5d88..e390159 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,11 @@
 # convert-markdown
 
-Simple Markdown to HTML converter using lowdown_file(3).
+Simple Markdown to HTML converter using [lowdown(3)][lowdown].
 
 ## Usage
 
+Pass Markdown to stdin and get an HTML fragment on stdout:
+
 ```console
 $ convert-markdown
 # header
@@ -12,26 +14,26 @@ hello **world**
 <h1 id="header">header</h1>
 
 <p>hello <strong>world</strong></p>
+$ convert-markdown < file.md > output.html
 ```
 
-```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>
+## License
 
-<pre><code class="language-console">$ convert-markdown
-# header
-hello **world**
-[Ctrl-D]
-&#60;h1 id="header"&#62;header&#60;&#47;h1&#62;
+This code is adapted from the example section of [lowdown_file(3)][lowdown_file], which is part of
+[lowdown][lowdown-site] by Kristaps Dzonsons <kristaps@bsd.lv>. Lowdown is free software released under the terms of the
+[ISC license][isc].
 
-&#60;p&#62;hello &#60;strong&#62;world&#60;&#47;strong&#62;&#60;&#47;p&#62;
-</code></pre>
-```
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted,
+provided that the above copyright notice and this permission notice appear in all copies.
 
-## License
+THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
+THIS
+SOFTWARE.
 
-[ISC](https://opensource.org/license/isc-license-txt/)
+[lowdown]: https://kristaps.bsd.lv/lowdown/lowdown.3.html
+[lowdown_file]: https://kristaps.bsd.lv/lowdown/lowdown_file.3.html
+[lowdown-site]: https://kristaps.bsd.lv/lowdown/
+[isc]: https://opensource.org/license/isc-license-txt/
-- 
cgit v1.2.3