Skip to content

Commit

Permalink
adjust README for 1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
jenshalm committed Oct 16, 2023
1 parent 120362f commit 87b2aeb
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 27 deletions.
27 changes: 4 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,38 +4,19 @@
Site and E-book Generator and Customizable Text Markup Transformer for sbt, Scala and Scala.js

![Build Status](https://github.com/typelevel/Laika/workflows/CI/badge.svg)
![Maven Central Release](https://img.shields.io/maven-central/v/org.planet42/laika-core_2.12.svg)
![Maven Central Release](https://img.shields.io/maven-central/v/org.typelevel/laika-core_2.12.svg)


Latest Release
--------------

* The latest pre-release is version **1.0.0-M5**.
* The latest stable release is version **0.19.5**.

If you are starting a new project with Laika, it is recommended to use the latest 1.0 milestone.
It is the final milestone and already very close to the first release candidate
and will prevent the need for a future migration.
0.19 won't receive any further patches unless a severe issue surfaces.

The library is published to Maven Central for Scala 3, 2.13, 2.12 and supports cats-effect 3.x and Scala.js 1.13+.
The sbt plugin is published for sbt 1.x.

Open Source under the Apache 2.0 License.


Adding Laika to your Build
--------------------------

The 1.0 milestones are published under `org.typelevel` organization, while the older 0.x releases were published under the `org.planet42` organization:

```scala
// for version 1.x:
addSbtPlugin("org.typelevel" % "laika-sbt" % "1.0.0-M5")
Version 1.0
-----------

// for version 0.19:
addSbtPlugin("org.planet42" % "laika-sbt" % "0.19.5")
```
1.x artefacts are now published under the `org.typelevel` organization as opposed to 0.x releases which were published under `org.planet42`.


Features
Expand Down
11 changes: 7 additions & 4 deletions project/ManualSettings.scala
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,16 @@ object ManualSettings {
case "1.x" => ("latest", true)
case _ => (version, false)
}
val v =
Version(version, pathSegment).withFallbackLink("/table-of-content.html").withLabel(label)

val v =
Version(version, pathSegment)
.withFallbackLink("/table-of-content.html")
.withLabel(label)
if (canonical) v.setCanonical else v
}

val v1 = version("1.x", "Dev")
val v019 = version("0.19", "Stable")
val v1 = version("1.x", "Stable")
val v019 = version("0.19")
val v018 = version("0.18")
val v017 = version("0.17")
val current = v1
Expand Down

0 comments on commit 87b2aeb

Please sign in to comment.