From 45e929bde31fe9c79049a4af88572862bcb720bf Mon Sep 17 00:00:00 2001 From: Jens Halm Date: Wed, 8 Jan 2014 15:35:12 +0100 Subject: [PATCH] update README, change version to 0.5.0 in build --- README.md | 29 +++++++++++++++++++++++++---- project/Build.scala | 2 +- 2 files changed, 26 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8104d197a..70b110fa6 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ ![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. @@ -8,13 +11,31 @@ 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: diff --git a/project/Build.scala b/project/Build.scala index afb3a4a0c..99d2b0abe 100644 --- a/project/Build.scala +++ b/project/Build.scala @@ -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")),