From 3acfe9c6e2a313a93211e06e0253369141cc0a4a Mon Sep 17 00:00:00 2001 From: trivernis Date: Wed, 16 Dec 2020 11:58:14 +0100 Subject: [PATCH] Update Readme Signed-off-by: trivernis --- README.md | 28 ++++++++++++++++++++++------ 1 file changed, 22 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 919831a..8137383 100644 --- a/README.md +++ b/README.md @@ -21,8 +21,29 @@ cargo install snekdown --features pdf ## Usage ``` +snekdown 0.30.5 + USAGE: - snekdown [FLAGS] [OPTIONS] [SUBCOMMAND] + snekdown + +FLAGS: + -h, --help Prints help information + -V, --version Prints version information + +SUBCOMMANDS: + clear-cache Clears the cache directory + help Prints this message or the help of the given subcommand(s) + render Parse and render the document + watch Watch the document and its imports and render on change +``` + +### Rendering / Watching + +``` +Parse and render the document + +USAGE: + snekdown render [FLAGS] [OPTIONS] FLAGS: -h, --help Prints help information @@ -35,11 +56,6 @@ OPTIONS: ARGS: Path to the input file Path for the output file - -SUBCOMMANDS: - help Prints this message or the help of the given subcommand(s) - render Default. Parse and render the document - watch Watch the document and its imports and render on change ``` ## Syntax