Skip to content

Commit 3ff9a3a

Browse files
authored
Polish documentation (#505)
* Upgrade the version of org.seasar.doma.compile * Remove the License section * Add some badges * Refine overview description * Refine the Example section * Add the Google Group section
1 parent 3eefe57 commit 3ff9a3a

File tree

2 files changed

+33
-28
lines changed

2 files changed

+33
-28
lines changed

README.md

Lines changed: 32 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,23 @@
1-
Doma [![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) [![Join the chat at https://gitter.im/domaframework/doma](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/domaframework/doma?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
2-
========================================
3-
4-
Doma is a database access framework for Java.
5-
Doma uses [Pluggable Annotation Processing API][apt] to generate source code and validate sql mappings **at compile time**.
6-
7-
Example
1+
Doma
2+
====
3+
4+
Doma 2 is a database access framework for Java 8+.
5+
Doma has various strengths:
6+
7+
- Verifies and generates source code **at compile time** using [annotation processing][apt].
8+
- Maps database columns to user-defined Java objects.
9+
- Uses SQL templates, called “two-way SQL”.
10+
- Supports classes introduced in Java 8, such as `java.time.LocalDate`, `java.util.Optional`, and `java.util.stream.Stream`.
11+
- Has no dependence on other libraries.
12+
13+
[![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)
14+
[![docs](https://readthedocs.org/projects/doma/badge/?version=latest)](https://doma.readthedocs.io/en/latest/)
15+
[![javadoc](https://javadoc.io/badge2/org.seasar.doma/doma-core/javadoc.svg)](https://javadoc.io/doc/org.seasar.doma/doma-core)
16+
[![Join the chat at https://gitter.im/domaframework/doma](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/domaframework/doma?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
17+
[![Google group : doma-user](https://img.shields.io/badge/Google%20Group-doma--user-orange.svg)](https://groups.google.com/g/doma-user)
18+
[![Twitter](https://img.shields.io/badge/[email protected]?style=flat)](https://twitter.com/domaframework)
19+
20+
Examples
821
---------------------
922

1023
Define an entity class:
@@ -48,7 +61,13 @@ public class App {
4861
}
4962
```
5063

51-
For more complete examples, see [domaframework/simple-examples](https://github.com/domaframework/simple-examples).
64+
Try following getting started examples:
65+
- [Get started! (IntelliJ IDEA)](https://doma.readthedocs.io/en/latest/getting-started-idea/)
66+
- [Get started! (Eclipse)](https://doma.readthedocs.io/en/latest/getting-started-eclipse/)
67+
68+
For more complete examples,
69+
see [simple-examples](https://github.com/domaframework/simple-examples)
70+
and [spring-boot-jpetstore](https://github.com/domaframework/spring-boot-jpetstore).
5271

5372
Build with Gradle
5473
-----------------
@@ -67,6 +86,11 @@ Documentation
6786

6887
https://doma.readthedocs.io/
6988

89+
Google Group
90+
---------------------
91+
92+
https://groups.google.com/g/doma-user
93+
7094
Related projects
7195
---------------------
7296

@@ -99,23 +123,4 @@ Major versions
99123
| Java 13 | | v |
100124
| Java 14 | | v |
101125

102-
License
103-
-------
104-
105-
```
106-
Copyright 2019 domaframework.org
107-
108-
Licensed under the Apache License, Version 2.0 (the "License");
109-
you may not use this file except in compliance with the License.
110-
You may obtain a copy of the License at
111-
112-
http://www.apache.org/licenses/LICENSE-2.0
113-
114-
Unless required by applicable law or agreed to in writing, software
115-
distributed under the License is distributed on an "AS IS" BASIS,
116-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
117-
See the License for the specific language governing permissions and
118-
limitations under the License.
119-
```
120-
121126
[apt]: https://www.jcp.org/en/jsr/detail?id=269

docs/kotlin-support.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ the `Doma Compile Plugin <https://github.com/domaframework/doma-compile-plugin>`
109109
.. code-block:: groovy
110110
111111
plugins {
112-
id 'org.seasar.doma.compile' version '1.0.0'
112+
id 'org.seasar.doma.compile' version '1.1.0'
113113
}
114114
115115
For more details, see this `build.gradle <https://github.com/domaframework/kotlin-sample/blob/master/build.gradle>`_.

0 commit comments

Comments
 (0)