diff --git a/README.md b/README.md index 0e30d34..7e0c0e7 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,15 @@ go-md2man Converts markdown into roff (man pages). -Uses blackfriday to process markdown into man pages. +Uses [blackfriday](https://github.com/russross/blackfriday) to process markdown into man pages. ### Usage +``` ./md2man -in /path/to/markdownfile.md -out /manfile/output/path +``` ### How to contribute We use go modules to manage dependencies. -As such you must be using at lest go1.11. +As such you must be using at least go1.11.