From 73d1d5d06126316c4d14b395b60e0a5d8ccc37df Mon Sep 17 00:00:00 2001 From: Christian Muehlhaeuser Date: Fri, 13 Dec 2019 03:25:02 +0100 Subject: [PATCH] Document -w flag in README --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f429abc..6543274 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Render markdown on the CLI, with _pizzazz_! ## Usage -Use a markdown source as the argument: +Use a markdown source as the primary argument: Read from file: ``` @@ -29,7 +29,23 @@ Fetch markdown from an HTTP source: When `gold` is started without any markdown source, it will try to find a `README.md` or `README` file in the current working directory. -You can supply a JSON stylesheet with the `-s` flag: +### Flags + +#### Word Wrapping + +The `-w` flag lets you set a maximum width, at which the output will be wrapped: +``` +./gold -w 60 +``` + +#### Styles + +You can choose a style with the `-s` flag (`dark` being the default): +``` +./gold -s [dark|light] +``` + +Alternatively you can also supply a custom JSON stylesheet: ``` ./gold -s mystyle.json ```