diff --git a/README.md b/README.md index 367b90b..2341a02 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,18 @@ -# d4s -Dynamo DB Database Done Scala-way +# **d4s** - *"Dynamo DB Database Done Scala-way"* +

+Logo +

+ +What is it? ![Build](https://github.com/PlayQ/d4s/workflows/Build/badge.svg) +=========== +__*d4s*__ - is a Scala library that allows you to work with DynamoDB in a pure functional way. +It's powered by [Izumi](https://izumi.7mind.io/latest/release/doc/index.html), uses Bifunctor IO and allows you to choose whatever effect type you want to use. It provides flexible and extensible DSL, supports AWS SDK v2 and has great integration with [ZIO](https://zio.dev/). + +include the following components: + +1. d4s – core package, the lib itself. +2. d4s-circe – provides circe codecs to encode the data. +3. d4s-test - provides test enviroment and docker containers via DIstage TestKit. +4. metrics - a small yet convinient package for metrics aggregation. +5. aws-common - tagging and namespaces + \ No newline at end of file diff --git a/docs/resourses/D4S_logo.svg b/docs/resourses/D4S_logo.svg new file mode 100644 index 0000000..14284fe --- /dev/null +++ b/docs/resourses/D4S_logo.svg @@ -0,0 +1,270 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/version.sbt b/version.sbt index 3265844..cbc7cf6 100644 --- a/version.sbt +++ b/version.sbt @@ -1 +1 @@ -version in ThisBuild := "1.0.0" +version in ThisBuild := "1.0.1"