Skip to content

Commit 9e8fdc1

Browse files
committed
Describe series/3.x in docs/index.md and regenerate README
Brief intro: a major overhaul of 2.x, highly modular with a zero-dependency core, high level API built on ZIO Blocks. Also fixes the install snippet's version — @Version@ falls back to the latest git tag across the whole repo's history (a 2.x release), which is misleading here; @SNAPSHOT_VERSION@ resolves to the actual 3.0.0-SNAPSHOT instead.
1 parent 6dd3a54 commit 9e8fdc1

2 files changed

Lines changed: 57 additions & 5 deletions

File tree

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
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+
[![Experimental](https://img.shields.io/badge/Project%20Stage-Experimental-yellowgreen.svg)](https://github.com/zio/zio/wiki/Project-Stages) ![CI Badge](https://github.com/zio/zio-dynamodb/workflows/CI/badge.svg) [![Sonatype Releases](https://img.shields.io/nexus/r/https/oss.sonatype.org/dev.zio/zio-dynamodb-core_2.13.svg?label=Sonatype%20Release)](https://oss.sonatype.org/content/repositories/releases/dev/zio/zio-dynamodb-core_2.13/) [![Sonatype Snapshots](https://img.shields.io/nexus/s/https/oss.sonatype.org/dev.zio/zio-dynamodb-core_2.13.svg?label=Sonatype%20Snapshot)](https://oss.sonatype.org/content/repositories/snapshots/dev/zio/zio-dynamodb-core_2.13/) [![javadoc](https://javadoc.io/badge2/dev.zio/zio-dynamodb-docs_2.13/javadoc.svg)](https://javadoc.io/doc/dev.zio/zio-dynamodb-docs_2.13) [![ZIO DynamoDB](https://img.shields.io/github/stars/zio/zio-dynamodb?style=social)](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)

docs/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ Simple, type-safe, and efficient access to DynamoDB
1010

1111
## Introduction
1212

13-
This is the `series/3.x` line of ZIO DynamoDB a from-scratch rewrite built on
14-
`zio-blocks-schema` rather than `zio-schema`. It is currently at an early, hello-world
15-
stage: the codebase and this documentation site are both placeholders while the real
16-
module-by-module import from the rewrite happens.
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.
1717

1818
For the current, production-ready release, see the [`series/2.x`
1919
documentation](https://zio.dev/zio-dynamodb/) instead.
@@ -24,6 +24,6 @@ To use ZIO DynamoDB 3.x, add the following to your `build.sbt` (not yet publishe
2424

2525
```scala
2626
libraryDependencies ++= Seq(
27-
"dev.zio" %% "zio-dynamodb" % "@VERSION@"
27+
"dev.zio" %% "zio-dynamodb" % "@SNAPSHOT_VERSION@"
2828
)
2929
```

0 commit comments

Comments
 (0)