Skip to content

Commit

Permalink
Command line documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
kevindew committed Sep 22, 2016
1 parent 489cf98 commit 411ba00
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,18 @@ then create a new document
doc = Govspeak::Document.new "^Test^"
puts doc.to_html

or alternatively, run it from the command line

$ govspeak "render-me"
$ govspeak --file render-me.md
$ echo "render-me" | govspeak

options can be passed in through `--options` as a string of JSON or a file
of JSON can be passed in as `--options-file options.json`.

if installed via bundler prefix commands with bundle exec eg `$ bundle exec govspeak "render-me"`


# Extensions

In addition to the [standard Markdown syntax](http://daringfireball.net/projects/markdown/syntax "Markdown syntax"), we have added our own extensions.
Expand Down

0 comments on commit 411ba00

Please sign in to comment.