From 5ffc54046a16e4b68debac5b78c82034d2f89aac Mon Sep 17 00:00:00 2001 From: Massimo Siani Date: Sun, 24 Jul 2022 18:01:38 +0200 Subject: [PATCH] add installation section in the docs --- .github/workflows/ci.yml | 4 ++-- build.sbt | 2 +- docs/index.md | 7 +++++++ 3 files changed, 10 insertions(+), 3 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 4c96677..acf9802 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -69,9 +69,9 @@ jobs: - name: Check that workflows are up to date run: sbt 'project ${{ matrix.project }}' '++${{ matrix.scala }}' 'project /' githubWorkflowCheck - - name: Check formatting + - name: Check headers and formatting if: matrix.java == 'temurin@8' - run: sbt 'project ${{ matrix.project }}' '++${{ matrix.scala }}' scalafmtCheckAll 'project /' scalafmtSbtCheck + run: sbt 'project ${{ matrix.project }}' '++${{ matrix.scala }}' headerCheckAll scalafmtCheckAll 'project /' scalafmtSbtCheck - name: Test run: sbt 'project ${{ matrix.project }}' '++${{ matrix.scala }}' test diff --git a/build.sbt b/build.sbt index 170e8a9..e0201ff 100644 --- a/build.sbt +++ b/build.sbt @@ -12,7 +12,7 @@ ThisBuild / developers := List( tlGitHubDev("massimosiani", "Massimo Siani") ) -ThisBuild / tlCiHeaderCheck := false +ThisBuild / tlCiHeaderCheck := true ThisBuild / tlCiScalafixCheck := true ThisBuild / tlCiScalafmtCheck := true ThisBuild / tlSitePublishBranch := Some("main") diff --git a/docs/index.md b/docs/index.md index 5f2a3a2..57e495e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,6 +6,13 @@ An integration library for Natchez and Akka Http. Only a server middleware has been implemented so far. +## Installation + +Add the following to your `build.sbt` +```scala +libraryDependencies ++= Seq("io.github.massimosiani" %% "natchez-akka-http" % ) +``` + ## Plain Akka Http If you only have the routes, then follow the example in the [vanilla akka http example](https://github.com/massimosiani/natchez-akka-http/tree/main/examples/vanilla-akka).