Skip to content

Commit 5c004d8

Browse files
authored
Improve README.md (#5)
* Add badges * Improve README.md
1 parent 5779aa7 commit 5c004d8

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
Doma CodeGen Plugin
22
===================
33

4-
![Java CI with Gradle](https://github.com/domaframework/doma-codegen-plugin/workflows/Java%20CI%20with%20Gradle/badge.svg)
5-
64
Doma CodeGen Plugin is a gradle plugin.
75
It generates Java source files and SQL files from Database.
86

7+
[![Java CI with Gradle](https://github.com/domaframework/doma-codegen-plugin/workflows/Java%20CI%20with%20Gradle/badge.svg)](https://github.com/domaframework/doma-codegen-plugin/actions?query=workflow%3A%22Java+CI+with+Gradle%22)
8+
[![Google Group : doma-user](https://img.shields.io/badge/Google%20Group-doma--user-orange.svg)](https://groups.google.com/g/doma-user)
9+
[![Twitter](https://img.shields.io/badge/[email protected]?style=flat)](https://twitter.com/domaframework)
10+
911
How to use
1012
----------
1113

12-
First, see [Gradle Plugin Portal](https://plugins.gradle.org/plugin/org.seasar.doma.codegen).
13-
14-
The basic usage example is as follows:
14+
The basic build.gradle example is as follows:
1515

1616
```groovy
1717
buildscript {
@@ -57,6 +57,13 @@ To generate all files, run `domaCodeGenDevAll` task:
5757
$ ./gradlew domaCodeGenDevAll
5858
```
5959

60+
See also [Gradle Plugin Portal](https://plugins.gradle.org/plugin/org.seasar.doma.codegen).
61+
62+
Sample Project
63+
--------------
64+
65+
- [codegen-sample](https://github.com/domaframework/codegen-sample)
66+
6067
Gradle Tasks
6168
------------
6269

@@ -238,8 +245,3 @@ domaCodeGen {
238245
```
239246

240247
The Doma CodeGen Plugin uses [Apache FreeMarker](https://freemarker.apache.org/) to process the template files.
241-
242-
Sample Project
243-
--------------
244-
245-
- [codegen-sample](https://github.com/domaframework/codegen-sample)

0 commit comments

Comments
 (0)