Skip to content

Commit

Permalink
Merge pull request jbake-org#12 from jonbullock/change/update-readme
Browse files Browse the repository at this point in the history
Updated readme with details of goals
  • Loading branch information
jonbullock authored Apr 23, 2018
2 parents 17acfbb + a4f74b3 commit 8ecf3d3
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.asciidoc
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -10,12 +10,27 @@ the following Maven coordinates:
<dependency>
<groupId>org.jbake</groupId>
<artifactId>jbake-maven-plugin</artifactId>
<version>0.2.0</version>
<version>0.3.1</version>
</dependency>
----

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.
Expand Down

0 comments on commit 8ecf3d3

Please sign in to comment.