|
| 1 | +[//]: # (This file was autogenerated using `zio-sbt-website` plugin via `sbt generateReadme` command.) |
| 2 | +[//]: # (So please do not edit it manually. Instead, change "docs/index.md" file or sbt setting keys) |
| 3 | +[//]: # (e.g. "readmeDocumentation" and "readmeSupport".) |
| 4 | + |
| 5 | +# ZIO DynamoDB |
| 6 | + |
| 7 | +Simple, type-safe, and efficient access to DynamoDB |
| 8 | + |
| 9 | +[](https://github.com/zio/zio/wiki/Project-Stages)  [](https://oss.sonatype.org/content/repositories/releases/dev/zio/zio-dynamodb-core_2.13/) [](https://oss.sonatype.org/content/repositories/snapshots/dev/zio/zio-dynamodb-core_2.13/) [](https://javadoc.io/doc/dev.zio/zio-dynamodb-docs_2.13) [](https://github.com/zio/zio-dynamodb) |
| 10 | + |
| 11 | +## Introduction |
| 12 | + |
| 13 | +`series/3.x` is a major overhaul of ZIO DynamoDB 2.x: a highly modular library with a |
| 14 | +zero-dependency core, plus a high level API built on [ZIO Blocks](https://zio.dev/zio-blocks). |
| 15 | +It's under active, module-by-module development — modules are being migrated in one at a |
| 16 | +time, so not everything from 2.x is available here yet. |
| 17 | + |
| 18 | +For the current, production-ready release, see the [`series/2.x` |
| 19 | +documentation](https://zio.dev/zio-dynamodb/) instead. |
| 20 | + |
| 21 | +## Installation |
| 22 | + |
| 23 | +To use ZIO DynamoDB 3.x, add the following to your `build.sbt` (not yet published): |
| 24 | + |
| 25 | +```scala |
| 26 | +libraryDependencies ++= Seq( |
| 27 | + "dev.zio" %% "zio-dynamodb" % "3.0.0-SNAPSHOT" |
| 28 | +) |
| 29 | +``` |
| 30 | + |
| 31 | +## Documentation |
| 32 | + |
| 33 | +Learn more on the [ZIO DynamoDB homepage](https://github.com/zio/zio-dynamodb)! |
| 34 | + |
| 35 | +## Contributing |
| 36 | + |
| 37 | +For the general guidelines, see ZIO [contributor's guide](https://zio.dev/contributor-guidelines). |
| 38 | + |
| 39 | +## Code of Conduct |
| 40 | + |
| 41 | +See the [Code of Conduct](https://zio.dev/code-of-conduct) |
| 42 | + |
| 43 | +## Support |
| 44 | + |
| 45 | +Come chat with us on [![Badge-Discord]][Link-Discord]. |
| 46 | + |
| 47 | +[Badge-Discord]: https://img.shields.io/discord/629491597070827530?logo=discord "chat on discord" |
| 48 | +[Link-Discord]: https://discord.gg/2ccFBr4 "Discord" |
| 49 | + |
| 50 | +## License |
| 51 | + |
| 52 | +[License](LICENSE) |
0 commit comments