diff --git a/README.asciidoc b/README.asciidoc index 538a30a2..eed9bc1a 100644 --- a/README.asciidoc +++ b/README.asciidoc @@ -1,6 +1,6 @@ = JBake Maven Plugin Jonathan Bullock -2017-06-02 +2018-04-23 :idprefix: JBake Maven Plugin is a Maven plugin allowing you to integrate http://jbake.org[JBake] into your projects build. This is the official version published at @@ -10,12 +10,27 @@ the following Maven coordinates: org.jbake jbake-maven-plugin - 0.2.0 + 0.3.1 ---- Special thanks must go to the original author of this plugin - https://github.com/aldrinleal[Aldrin Leal]. +== Goals + +There are 4 goals provided by this plugin: + +* `jbake:seed` - seeds your project/site with example content and templates +* `jbake:generate` - bakes your project/site +* `jbake:watch` - watches to changes and bakes your site whenever a change is detected +* `jbake:inline` - bakes, watches and serves out content on http://localhost:8080[http://localhost:8080] + +You can also more details on each goal by running the help goal: + +---- +$ mvn jbake:help -Ddetail # -DgoalName=[seed|generate|watch|inline] +---- + == Versioning The project adopts the http://semver.org[Semantic Versioning] spec to maintain an understandable backwards compatibility strategy.