~kota/gemgen: document output to stdout

1eef8c2cc3a179d24d83b0ee0618d248a47b9ac0 — Dakota Walsh 2 years ago 0cd9c9a

document output to stdout

Reading markdown from STDIN and writing to STDOUT was added a while ago,
but unfortunately the feature broke as I wasn't using it or testing it
myself. Recently, ~alterae <alterae@git.sr.ht> sent a patch fixing the
feature. This patch adds documentation to the README and man page.

patch browse .tar.gz

2 files changed, 6 insertions(+), 2 deletions(-)

M README.md
M gemgen.1.scd

M README.md => README.md +3 -1

@@ 5,7 5,9 @@
 Command line tool for converting [Commonmark Markdown](https://commonmark.org/)
 to [Gemtext](https://gemini.circumlunar.space/docs/gemtext.gmi). Gemgen uses the
 [goldmark](https://pkg.go.dev/github.com/yuin/goldmark) markdown parser and [my
-gemtext rendering module](https://git.sr.ht/~kota/goldmark-gemtext/).
+gemtext rendering module](https://git.sr.ht/~kota/goldmark-gemtext/). You may
+pass gemgen a list of files to convert and rename concurrently or pass markdown
+into STDIN and get gemtext from STDOUT.
 
 The goal is to create proper _hand-made_ gemtext. Links and "autolinks" get
 placed below each paragraph, but a list of links is not printed twice.

M gemgen.1.scd => gemgen.1.scd +3 -1

@@ 11,7 11,9 @@ _gemgen_ [OPTION]... [FILE]...
 # DESCRIPTION
 
 *gemgen* is a tool for converting Commonmark Markdown to Gemtext. Gemgen uses
-the goldmark markdown parser and my gemtext rendering module.
+the goldmark markdown parser and my gemtext rendering module. You may pass
+gemgen a list of files to convert and rename concurrently or pass markdown into
+STDIN and get gemtext from STDOUT.
 
 The goal is to create proper _hand-made_ gemtext. Links and "autolinks" get
 placed below each paragraph, but a list of links is not printed twice.