Skip to content

Commit 7f0c095

Browse files
easybesteasybest
authored
Reformat the README (#256)
* reformat the readme file
1 parent 75a6cfe commit 7f0c095

File tree

3 files changed

+148
-243
lines changed

3 files changed

+148
-243
lines changed

Diff for: ‎README.md

+101-17
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,110 @@
1-
# Spring Data MyBatis
1+
<p align="center">
2+
<a href="https://github.com/easybest/spring-data-mybatis">
3+
<img src="https://raw.githubusercontent.com/easybest/spring-data-mybatis/dameng/logo.png"/>
4+
</a>
5+
</p>
26

3-
[![Build](https://github.com/easybest/spring-data-mybatis/actions/workflows/github-actions-ci.yml/badge.svg)](https://github.com/easybest/spring-data-mybatis/actions/workflows/github-actions-ci.yml)
4-
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.easybest/spring-data-mybatis/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.easybest/spring-data-mybatis)
5-
[![License: Apache 2.0](https://img.shields.io/badge/license-Apache_2.0-brightgreen.svg)](https://github.com/hatunet/spring-data-mybatis/blob/main/LICENSE)
7+
----
68

7-
[Simplified Chinese](README_zh.md)
9+
<p align="center">
10+
<a href="https://github.com/easybest/spring-data-mybatis/actions/workflows/github-actions-ci.yml" title="Build">
11+
<img src="https://github.com/easybest/spring-data-mybatis/actions/workflows/github-actions-ci.yml/badge.svg"/>
12+
</a>
13+
<a href="https://maven-badges.herokuapp.com/maven-central/io.easybest/spring-data-mybatis" title="Maven Central">
14+
<img src="https://maven-badges.herokuapp.com/maven-central/io.easybest/spring-data-mybatis/badge.svg"/>
15+
</a>
16+
<a href="https://github.com/hatunet/spring-data-mybatis/blob/main/LICENSE" title="License: Apache 2.0">
17+
<img src="https://img.shields.io/badge/license-Apache_2.0-brightgreen.svg"/>
18+
</a>
19+
<a href="https://gitter.im/spring-data-mybatis" title="Gitter chat">
20+
<img src="https://badges.gitter.im/gitterHQ/gitter.png"/>
21+
</a>
22+
</p>
823

9-
[Documentation](https://sdm.easybest.io)
24+
The primary goal of the Spring Data project is to make it easier to build Spring-powered applications that use data
25+
access technologies.
1026

11-
[Example Project](https://github.com/easybest/spring-data-mybatis-samples)
12-
13-
The primary goal of the Spring Data project is to make it easier to build Spring-powered applications that use data access technologies.
1427
This module deals with enhanced support for MyBatis based data access layers.
28+
**This module _does not_ make any modifications to MyBatis**. Non-invasive enhancement of MyBatis functionality by using
29+
the pre-compiled MyBatis Mapper Statement mode take developers more flexibility.
30+
At the same time, you can use the Spring Data pattern to reduce the amount of code and improve development efficiency.
31+
32+
> To put it bluntly, it is to help you automatically generate the Mapper files in advance, all the SQLs are ready, and
33+
> then, the essence is still MyBatis. Developers who use MyBatis no longer need to envy Spring Data JPA and the like ^_^
34+
35+
## Useful Links
1536

37+
* [Documentation](https://sdm.easybest.io)
38+
* [Example Project](https://github.com/easybest/spring-data-mybatis-samples)
39+
* [Simplified Chinese](README_zh.md)
1640

1741
## Features ##
1842

19-
* Implementation of CRUD methods for normal Entities
20-
* Dynamic query generation from query method names
21-
* Implementation domain base classes providing basic properties
22-
* Support for transparent auditing (created, last changed)
23-
* Possibility to integrate custom repository code
24-
* Easy Spring integration with custom namespace
25-
* Support MySQL, Oracle, Sql Server, H2, PostgreSQL, etc.
26-
* Support SpringBoot 2.x
43+
* Do not invade MyBatis, completely native use
44+
* Use standard Java Persistence API (JPA) annotations
45+
* Supports full CRUD operations on Entities, as well as more complex queries
46+
* Support to generate corresponding query by method name in interface (Spring Data)
47+
* Support associated queries, support automatic identification of associated query conditions
48+
* Entity base class that provides basic properties
49+
* Support transparent auditing (such as creation time, last modification)
50+
* Self-sustained custom writing of MyBatis-based queries, convenient and flexible
51+
* Easy integration with Spring and Spring Boot
52+
* Support MySQL, Oracle, SQL Server, H2, PostgreSQL, DB2, Derby, HSQL, Phoenix, MariaDB, Sqlite, Informix, HerdDB,
53+
Clickhouse, PolarDB, DM, OSCAR, HighGO, XUGU, Kingbase etc.
54+
55+
## Getting Help ##
56+
57+
Here is a document to help you learn Spring Data Mybatis quickly. [reference documentation](https://sdm.easybest.io)
58+
59+
If you have any questions or suggestions, you can record
60+
an [issue](https://github.com/easybest/spring-data-mybatis/issues) for me.
61+
62+
## Quick Start ##
63+
64+
### Installation
65+
66+
#### Maven
67+
68+
```xml
69+
70+
<dependency>
71+
<groupId>io.easybest</groupId>
72+
<artifactId>spring-data-mybatis</artifactId>
73+
<version>2.1.0</version>
74+
</dependency>
75+
```
76+
77+
In Spring Boot, use the following starter directly:
78+
79+
```xml
80+
81+
<dependency>
82+
<groupId>io.easybest</groupId>
83+
<artifactId>spring-data-mybatis-starter</artifactId>
84+
<version>2.1.0</version>
85+
</dependency>
86+
```
87+
88+
#### Gradle
89+
90+
```groovy
91+
implementation('io.easybest:spring-data-mybatis:2.1.0')
92+
```
93+
94+
In Spring Boot, use the following starter directly:
95+
96+
```groovy
97+
implementation('io.easybest:spring-data-mybatis-starter:2.1.0')
98+
```
99+
100+
## Contributing
101+
102+
Here are some ways for you to get involved in the community:
103+
104+
* GitHub is for social coding: if you want to write code, we encourage contributions through pull requests
105+
from [forks of this repository](https://help.github.com/forking/).
106+
107+
## Donation
108+
109+
[![paypal](https://www.paypal.com/en_US/i/btn/x-click-butcc-donate.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=W7PLNCBK5K8JS)
110+

0 commit comments

Comments
 (0)