diff --git a/README.md b/README.md index 0c4da1d..c81dbb2 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,17 @@ Turn a simple Markdown document into an elegant resume. php ./build/build.php --source sample.md php ./build/build.php --source sample.md --pdf +## Options + +If you want to edit your markdown resume in your editor while watching it +update in your browser, run this command: + + watch php ./build/build.php -s sample.md -r + +This makes the build script run periodically, and html document will refresh +every two seconds. Open the `./ouput/sample.html` file in your browser, and +then just save your markdown document when you want to see a fresh preview. + ## Development Markdown is limited to basic html markup. Follow the `resume/sample.md` file