Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
hermannm committed Sep 18, 2024
1 parent 60051e1 commit cb95a29
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
# liflig-document-store
# Liflig Document Store

Kotlin library implementing the repository pattern for storing documents as JSONB in Postgres.

- CRUD-like repository with extendable methods for flexibility.
- Optimistic locking.
- JDBI library for convenience.
- Serialization and deserialization of objects using Kotlinx Serialization.
- Connection pool with HikariCP.
- Database migrations with Flyway.
Provides:

- Extendible repository class, with default implementations of CRUD operations
- Optimistic locking
- Transaction management
- Migration utilities

Document Store uses the [JDBI library](https://jdbi.org/releases/3.45.1/#_introduction_to_jdbi_3)
for convenient database access.

This library is currently only distributed in Liflig internal repositories.

Expand All @@ -17,13 +20,10 @@ See [docs/usage.md](docs/usage.md).

## Contributing

This project follows
https://confluence.capraconsulting.no/x/fckBC

To check build before pushing:

```bash
mvn verify
```

The CI server will automatically release new version for builds on master.
GitHub Actions will automatically release a new version for commits on master.

0 comments on commit cb95a29

Please sign in to comment.