Skip to content

Commit 7ab69fe

Browse files
committed
Update README
1 parent fd99121 commit 7ab69fe

File tree

1 file changed

+41
-12
lines changed

1 file changed

+41
-12
lines changed

README.md

Lines changed: 41 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,48 @@
1-
# GORM for MongoDB
2-
[![Maven Central](https://img.shields.io/maven-central/v/org.grails/grails-datastore-gorm-mongodb.svg?label=Maven%20Central)](https://central.sonatype.com/artifact/org.grails/grails-datastore-gorm-mongodb)
3-
[![Java CI](https://github.com/grails/gorm-mongodb/actions/workflows/gradle.yml/badge.svg?event=push)](https://github.com/grails/gorm-mongodb/actions/workflows/gradle.yml)
1+
[![Main branch build status](https://github.com/graceframework/grace-data-mongodb/workflows/Grace%20CI/badge.svg?style=flat)](https://github.com/graceframework/grace-data-mongodb/actions?query=workflow%3A%Grace+CI%22)
2+
[![Apache 2.0 license](https://img.shields.io/badge/License-APACHE%202.0-green.svg?logo=APACHE&style=flat)](https://opensource.org/licenses/Apache-2.0)
3+
[![Latest version on Maven Central](https://img.shields.io/maven-central/v/org.graceframework.plugins/mongodb.svg?label=Maven%20Central&logo=apache-maven&style=flat)](https://search.maven.org/search?q=g:org.graceframework.plugins)
4+
[![Grace on X](https://img.shields.io/twitter/follow/graceframework?style=social)](https://x.com/graceframework)
45

5-
This project implements [GORM](https://gorm.grails.org) for the MongoDB Document Database.
6+
[![Groovy Version](https://img.shields.io/badge/Groovy-4.0.24-blue?style=flat&color=4298b8)](https://groovy-lang.org/releasenotes/groovy-4.0.html)
7+
[![Grace Version](https://img.shields.io/badge/Grace-2023.3.0-blue?style=flat&color=f49b06)](https://github.com/graceframework/grace-framework/releases/tag/v2023.3.0-M1)
8+
[![Spring Boot Version](https://img.shields.io/badge/Spring_Boot-3.3.7-blue?style=flat&color=6db33f)](https://github.com/spring-projects/spring-boot/releases/tag/v3.3.7)
69

7-
>[!NOTE]
8-
>The source code in this repository is version 6.x and above. For previous versions, see the [relevant branch](https://github.com/grails/grails-data-mapping/tree/5.x/grails-datastore-gorm-mongodb) on the [Grails Data Mapping project](https://github.com/grails/grails-data-mapping).
10+
# Grace Data for MongoDB
911

10-
For more information see the following links:
12+
This project implements [GORM](https://github.com/graceframework/grace-data) for the [MongoDB Document Database](https://www.mongodb.com).
1113

12-
* [Documentation](https://gorm.grails.org/latest/mongodb/manual)
13-
* [API](https://gorm.grails.org/latest/mongodb/api)
14+
This project aims to provide an Object-Mapping layer on top of MongoDB to ease common activities such as:
1415

15-
For the current development version see the following links:
16+
* Marshalling from Mongo to Groovy/Java types and back again
17+
* Support for GORM dynamic finders, criteria and named queries
18+
* Session-managed transactions
19+
* Validating domain instances backed by the Mongo datastore
1620

17-
* [Snapshot Documentation](https://gorm.grails.org/snapshot/mongodb/manual)
18-
* [Snapshot API](https://gorm.grails.org/snapshot/mongodb/api)
21+
> [!IMPORTANT]
22+
> Currently, this plugin has been upgraded to MongoDB Driver 5.0.1, but only support Grace Framework 2023.3.x.
1923
24+
25+
```gradle
26+
dependencies {
27+
implementation "org.graceframework.plugins:mongodb"
28+
}
29+
```
30+
31+
## Versions
32+
33+
To make it easier for users to use and upgrade, Grace Data MongoDB adopts a version policy consistent with the [Grace Framework](https://github.com/graceframework/grace-framework).
34+
35+
| GORM MongoDb Version | Grace Version |
36+
|------------------------|---------------|
37+
| 2023.3.x | 2023.3.x |
38+
39+
## License
40+
41+
This plugin is available as open source under the terms of the [APACHE LICENSE, VERSION 2.0](http://apache.org/Licenses/LICENSE-2.0)
42+
43+
## Links
44+
45+
- [Grace Framework](https://github.com/graceframework/grace-framework)
46+
- [Grace Data](https://github.com/graceframework/grace-data)
47+
- [Grace Data Hibernate](https://github.com/graceframework/grace-data-hibernate)
48+
- [MongoDB Database](https://www.mongodb.com)

0 commit comments

Comments
 (0)