add installation section in the docs

massimosiani · Jul 24, 2022 · 5ffc540 · 5ffc540
1 parent ac5cb0d
commit 5ffc540
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 3 deletions.
diff --git 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
@@ -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
@@ -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" % <version>)
+```
+
 ## 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).