Skip to content

Commit d8286e7

Browse files
committed
Polish README.md
1 parent a24a65d commit d8286e7

File tree

1 file changed

+34
-6
lines changed

1 file changed

+34
-6
lines changed

README.md

Lines changed: 34 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,33 @@ Doma has various strengths:
1010
- Uses SQL templates, called "two-way SQL".
1111
- Has no dependence on other libraries.
1212

13-
The latest major version of Doma supports Java 17 and above.
14-
1513
[![Build Status](https://github.com/domaframework/doma/workflows/Java%20CI%20with%20Gradle/badge.svg)](https://github.com/domaframework/doma/actions?query=workflow%3A%22Java+CI+with+Gradle%22)
1614
[![javadoc](https://javadoc.io/badge2/org.seasar.doma/doma-core/javadoc.svg)](https://javadoc.io/doc/org.seasar.doma/doma-core)
1715
[![project chat](https://img.shields.io/badge/zulip-join_chat-green.svg)](https://domaframework.zulipchat.com)
1816
[![Twitter](https://img.shields.io/badge/[email protected]?style=flat)](https://twitter.com/domaframework)
1917

18+
Prerequisite
19+
---------------------
20+
21+
The latest major version of Doma supports Java 17 and above.
22+
If you are using Java 8, please use Doma 2.
23+
24+
See also [Major versions](#major-versions).
25+
26+
Supported databases
27+
---------------------
28+
29+
We are testing against the following databases:
30+
31+
| Database | version | status |
32+
|--------------------|-------------:|:----------:|
33+
| H2 Database | 2.3.x | stable |
34+
| MySQL v5 | 5.7 | stable |
35+
| MySQL v8 | 8.0.36 | stable |
36+
| Oracle Database XE | 21c | stable |
37+
| PostgreSQL | 12.20 | stable |
38+
| SQL Server | 2019 | stable |
39+
2040
Examples
2141
---------------------
2242

@@ -73,7 +93,11 @@ Installing
7393

7494
For Java projects:
7595

76-
```groovy
96+
```kotlin
97+
plugins {
98+
id("org.domaframework.doma.compile") version "2.0.0"
99+
}
100+
77101
dependencies {
78102
implementation("org.seasar.doma:doma-core:2.62.1")
79103
annotationProcessor("org.seasar.doma:doma-processor:2.62.1")
@@ -82,7 +106,11 @@ dependencies {
82106

83107
For Kotlin projects, use doma-kotlin instead of doma-core and use kapt in place of annotationProcessor:
84108

85-
```groovy
109+
```kotlin
110+
plugins {
111+
id("org.domaframework.doma.compile") version "2.0.0"
112+
}
113+
86114
dependencies {
87115
implementation("org.seasar.doma:doma-kotlin:2.62.1")
88116
kapt("org.seasar.doma:doma-processor:2.62.1")
@@ -116,8 +144,8 @@ For Java projects:
116144
<artifactId>maven-compiler-plugin</artifactId>
117145
<version>3.8.1</version>
118146
<configuration>
119-
<source>1.8</source> <!-- depending on your project -->
120-
<target>1.8</target> <!-- depending on your project -->
147+
<source>17</source> <!-- depending on your project -->
148+
<target>17</target> <!-- depending on your project -->
121149
<annotationProcessorPaths>
122150
<path>
123151
<groupId>org.seasar.doma</groupId>

0 commit comments

Comments
 (0)