summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorivanceras <ivanceras@gmail.com>2017-09-05 17:16:16 +0800
committerGitHub <noreply@github.com>2017-09-05 17:16:16 +0800
commitc4bc7cba4cf622562d6a3d39f9c948eaa0019426 (patch)
treee111f9add5efb922b5ea53e68e0a70aec4cbcc10 /README.md
parentc4d42cd18061c117ec3868ad54d7aa65747dc4e6 (diff)
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 17 insertions, 3 deletions
diff --git a/README.md b/README.md
index e80254c..2f3ca18 100644
--- a/README.md
+++ b/README.md
@@ -35,24 +35,38 @@ $ svgbob -o long.svg < examples/long.bob
$ svgbob examples/long.bob > long.svg
```
+You can pipe string from the output of other program:
+```console
+echo -e "+--+\n| |\n+--+" | svgbob
+```
+You can also pass an inline string:
+```console
+svgbob -s -- "+--+\n| |\n+--+"
+```
+
This is also documented in the output of `svgbob --help`:
```console
$ svgbob --help
-svgbob 0.1.2
+svgbob 0.2.1
SvgBobRus is an ascii to svg converter
USAGE:
- svgbob [OPTIONS] [input]
+ svgbob [FLAGS] [OPTIONS] [input] [SUBCOMMAND]
FLAGS:
-h, --help Prints help information
+ -s parse an inline string
-V, --version Prints version information
OPTIONS:
-o, --output <output> where to write svg output [default: STDOUT]
ARGS:
- <input> svgbob text file to parse [default: STDIN]
+ <input> svgbob text file or inline string to parse [default: STDIN]
+
+SUBCOMMANDS:
+ build Batch convert files to svg.
+ help Prints this message or the help of the given subcommand(s)
```