Skip to content

Commit

Permalink
Update the installation guide (#50)
Browse files Browse the repository at this point in the history
* Update the installation guide

* Change Seq to List
  • Loading branch information
mvelimir authored Sep 23, 2022
1 parent c1c2efe commit 9e949aa
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 4 deletions.
3 changes: 3 additions & 0 deletions build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ lazy val root = (project in file("."))
name := "scurl-detector",
crossScalaVersions := List("2.12.17", "2.13.8"),
libraryDependencies ++= All,
buildInfoKeys := List[BuildInfoKey](organization, name, version),
buildInfoPackage := "detection",
semanticdbEnabled := true,
semanticdbVersion := scalafixSemanticdb.revision,
scalacOptions += {
Expand All @@ -56,6 +58,7 @@ lazy val root = (project in file("."))
}
}
)
.enablePlugins(BuildInfoPlugin)

lazy val docs = (project in file("scurl-detector-docs"))
.settings(
Expand Down
9 changes: 5 additions & 4 deletions docs/overview/overview_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,10 @@ Scala URL Detector is a Scala library that detects and extracts URLs from text.

## Installation

To use the latest snapshot of Scala URL Detector in your project add the following to your build.sbt file:
To use the latest release of Scala URL Detector in your project add the following to your `build.sbt` file:

```scala
resolvers ++= Resolver.sonatypeOssRepos("snapshots")
libraryDependencies += "io.lambdaworks" %% "scurl-detector" % "@SNAPSHOT_VERSION@"
```scala mdoc:passthrough
println(s"""```scala""")
println(s"""libraryDependencies += "${detection.BuildInfo.organization}" %% "${detection.BuildInfo.name}" % "${detection.BuildInfo.version.split('+').head}"""")
println(s"""```""")
```
1 change: 1 addition & 0 deletions project/plugin.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % "0.10.2")
addSbtPlugin("com.github.sbt" % "sbt-ci-release" % "1.5.10")
addSbtPlugin("org.scalameta" % "sbt-mdoc" % "2.3.3")
addSbtPlugin("com.github.sbt" % "sbt-unidoc" % "0.5.0")
addSbtPlugin("com.eed3si9n" % "sbt-buildinfo" % "0.11.0")

0 comments on commit 9e949aa

Please sign in to comment.