Skip to content

Commit 39f32fb

Browse files
committed
Readme
1 parent 633412a commit 39f32fb

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

README.md

+13-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.softwaremill.akka-http-session/core_2.12/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.softwaremill.akka-http-session/core_2.12)
66

77
[`akka-http`](https://doc.akka.io/docs/akka-http/current/index.html) is an Akka
8-
module, originating from [spray.io](http://spray.io), for building *reactive* REST services with an elegant DSL.
8+
module, originating from [spray.io](http://spray.io), for building *reactive* REST services with an elegant DSL.
9+
[`pekko-http`](https://pekko.apache.org/docs/pekko-http/current/) is an open-source fork of akka-http.
910

1011
`akka-http` is a great toolkit for building backends for single-page or mobile applications. In almost all apps there
1112
is a need to maintain user sessions, make sure session data is secure and cannot be tampered with.
@@ -15,6 +16,9 @@ or custom headers + local storage, with optional [Json Web Tokens](http://jwt.io
1516

1617
A [comprehensive FAQ](https://github.com/softwaremill/akka-http-session-faq) is available, along with code examples (in Java, but easy to translate to Scala) which answers many common questions on how sessions work, how to secure them and implement using akka-http.
1718

19+
Each `akka-http-session` module for `akka-http` has a corresponding `pekko-http` module, with a different group id
20+
(see bottom of the readme).
21+
1822
## What is a session?
1923

2024
Session data typically contains at least the `id` or `username` of the logged in user. This id must be secured so that a
@@ -305,6 +309,13 @@ libraryDependencies += "com.softwaremill.akka-http-session" %% "core" % "0.7.0"
305309
libraryDependencies += "com.softwaremill.akka-http-session" %% "jwt" % "0.7.0" // optional
306310
````
307311

312+
For `pekko-http`:
313+
314+
````scala
315+
libraryDependencies += "com.softwaremill.pekko-http-session" %% "core" % "0.7.0"
316+
libraryDependencies += "com.softwaremill.pekko-http-session" %% "jwt" % "0.7.0" // optional
317+
````
318+
308319
## Updating
309320

310321
Certain releases changed the client token encoding/serialization. In those cases, it's important to enable the appropriate
@@ -328,4 +339,4 @@ We offer commercial support for akka-http-session and related technologies, as w
328339

329340
## Copyright
330341

331-
Copyright (C) 2016-2021 SoftwareMill [https://softwaremill.com](https://softwaremill.com).
342+
Copyright (C) 2016-2023 SoftwareMill [https://softwaremill.com](https://softwaremill.com).

0 commit comments

Comments
 (0)