README.md in hubdown-0.0.3 vs README.md in hubdown-0.0.4

- old
+ new

@@ -13,12 +13,12 @@ ## Usage There are essentially 3 options when using `hubdown`. * Printing to STDOUT - * Writing to a file - * Previewing in browser + * Wrap in Github HTML + * Output to a file *** ### Printing to STDOUT To convert github flavored markdown to html simply execute hubdown and pass it a valid markdown file: @@ -27,24 +27,24 @@ $ hubdown my_file.md ``` Doing so will send converted markdown to standard output allowing you to pipe the file as you wish. *** -### Writing to a file +### Wrap in Github HTML ```bash -$ hubdown my_file.md -o my_file.html +$ hubdown file.md -w ``` -When passing the `-o` flag with a file name, hubdown will write the usual output (html) to the file you pass with `-o`. +When passing the `-w` flag hubdown will render the markdown in an approximation of what Github provides and push it to STDOUT. *** -### Previewing in browser +### Output to a file ```bash -$ hubdown file.md -p +$ hubdown my_file.md -o my_file.html ``` -When passing the `-p` flag hubdown will pass the output (as though it generated a file) to your default web browser for previewing. +When passing the `-o` flag with a file name, hubdown will write the full html output (as though you passed the `-w`) to the file you pass with `-o`. *** ## Contributing 1. Fork it