Skip to content

Commit

Permalink
update README, change version to 0.5.0 in build
Browse files Browse the repository at this point in the history
  • Loading branch information
Jens Halm committed Jan 8, 2014
1 parent 4ebac4a commit 45e929b
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 5 deletions.
29 changes: 25 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,41 @@
![Laika](http://planet42.github.io/Laika/img/laika-top.png)

Customizable and extensible toolkit for transforming lightweight text markup into various types of output formats, written in Scala.
Customizable and extensible toolkit for transforming lightweight text markup and template based site generation.

Supporting Markdown and reStructuredText as input and HTML as output, through its integrated
sbt plugin or embedded in Scala applications, without the need to install external tools.

Open Source under the Apache 2.0 License.


Getting Started
---------------

The current version is published to Maven Central for Scala 2.10.x, 2.9.3 and 2.9.2.
The main artifact is published to Maven Central for Scala 2.10.x.

The sbt plugin is published to the sbt plugin repository for sbt 0.13.x.


**Using the sbt Plugin:**

Add the plugin to `project/plugins.sbt`:

addSbtPlugin("org.planet42" % "laika-sbt" % "0.5.0")

Import its default settings in your project's `build.sbt`:

LaikaPlugin.defaults

Add Markdown, reStructuredText or HTML template files to `src/docs` in your
project and run the `laika:site` task from within sbt to generate the site
in `target/docs/site`.


Adding Laika to your project with sbt:
**Using Laika Embedded:**

libraryDependencies += "org.planet42" %% "laika" % "0.4.0"
Adding the Laika dependency to your sbt build:

libraryDependencies += "org.planet42" %% "laika-core" % "0.5.0"

Example for transforming from file to file:

Expand Down
2 changes: 1 addition & 1 deletion project/Build.scala
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ object Build extends Build {
object Settings {

lazy val basic = Seq(
version := "0.5.0-SNAPSHOT",
version := "0.5.0",
homepage := Some(new URL("http://planet42.github.io/Laika/")),
organization := "org.planet42",
organizationHomepage := Some(new URL("http://www.planet42.org")),
Expand Down

0 comments on commit 45e929b

Please sign in to comment.