Skip to content

docs: Update readme with more clear libraries distinction #182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 7, 2025
Merged

docs: Update readme with more clear libraries distinction #182

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
430abb1
docs: Update readme with more clear libraries distinction
johanandren Nov 5, 2025
45f3e7c
SDK URL
ennru Nov 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 21 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,29 @@
# Amazon DynamoDB Plugin for Akka Persistence
Akka
====
*Akka is a powerful platform that simplifies building and operating highly responsive, resilient, and scalable services.*

The Akka family of projects is managed by teams at [Lightbend](https://lightbend.com/) with help from the community.

The platform consists of
* the [**Akka SDK**](https://doc.akka.io/) for straightforward, rapid development with AI assist and automatic clustering. Services built with the Akka SDK are automatically clustered and can be deployed on any infrastructure.
* and [**Akka Automated Operations**](https://doc.akka.io/operations/akka-platform.html), a managed solution that handles everything for Akka SDK services from auto-elasticity to multi-region high availability running safely within your VPC.

The **Akka SDK** and **Akka Automated Operations** are built upon the foundational [**Akka libraries**](https://doc.akka.io/libraries/akka-dependencies/current/), providing the building blocks for distributed systems.

Amazon DynamoDB Plugin for Akka Persistence
===========================================

[Akka Persistence](https://doc.akka.io/docs/akka/current/scala/persistence.html) journal and snapshot
store for DynamoDB.

The documentation can be found [here](https://doc.akka.io/docs/akka-persistence-dynamodb/current/index.html)

Reference Documentation
-----------------------

The reference documentation for all Akka libraries is available via [doc.akka.io/libraries/](https://doc.akka.io/libraries/), details for the Akka Amazon DynamoDB Plugin for Akka Persistence
for [Scala](https://doc.akka.io/libraries/akka-persistence-dynamodb/current/?language=scala) and [Java](https://doc.akka.io/libraries/akka-persistence-dynamodb/current/?language=java).

The current versions of all Akka libraries are listed on the [Akka Dependencies](https://doc.akka.io/libraries/akka-dependencies/current/) page. Releases of the Akka Amazon DynamoDB Plugin for Akka Persistence in this repository are listed on the [GitHub releases](https://github.com/akka/akka-persistence-dynamodb/releases) page.


## Project status

Expand Down
Loading