Skip to content

Commit 8888b6d

Browse files
authored
Merge pull request #51 from grails-plugins/post-release-readme-updates
Updated README after RC1 release, update docs link in plugin
2 parents 3430799 + 18cf0e1 commit 8888b6d

2 files changed

Lines changed: 23 additions & 8 deletions

File tree

README.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,34 @@
11
🧩 Grails Cache Ehcache Plugin
22
====================
33

4-
Makes Ehcache the cache implementation for the [Grails Cache Plugin](https://github.com/grails-plugins/grails-cache)
4+
[![Maven Central](https://img.shields.io/maven-metadata/v.svg?metadataUrl=https://repo1.maven.org/maven2/org/grails/plugins/cache-ehcache/maven-metadata.xml&label=maven-central)](https://central.sonatype.com/artifact/org.grails.plugins/cache-ehcache)
5+
[![CI](https://github.com/grails-plugins/grails-cache-ehcache/actions/workflows/ci.yml/badge.svg?event=push)](https://github.com/grails-plugins/grails-cache-ehcache/actions/workflows/ci.yml)
56

6-
## Grails 7
7+
Makes [Ehcache](https://www.ehcache.org/) the cache implementation for the [Grails Cache Plugin](https://github.com/apache/grails-core/)
78

8-
TODO...
9+
## 🚀 Quick Start
910

10-
## Grails 3
11+
Add the dependency to your `build.gradle`:
1112

12-
📖 [Documentation](http://grails-plugins.github.io/grails-cache-ehcache/latest/)
13+
### Grails 7
1314

14-
## Grails 2
15+
```groovy
16+
dependencies {
17+
implementation "org.grails.plugins:cache-ehcache:5.0.0-RC1"
18+
}
19+
```
1520

16-
📖 [Documentation](http://grails-plugins.github.io/grails-cache-ehcache/)
21+
### Grails 3+
22+
23+
```groovy
24+
dependencies {
25+
compile "org.grails.plugins:cache-ehcache:3.0.0"
26+
}
27+
```
28+
29+
## 📖 Documentation
30+
31+
Full documentation is available at the project [documentation](http://grails-plugins.github.io/grails-cache-ehcache/) site.
1732

1833
## Branches
1934

src/main/groovy/grails/plugin/cache/ehcache/CacheEhcacheGrailsPlugin.groovy

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ An Ehcache-based implementation of the Cache plugin.
1717
def profiles = ['web']
1818

1919
// URL to the plugin's documentation
20-
def documentation = "https://grails.org/plugin/cache-ehcache"
20+
def documentation = "https://grails-plugins.github.io/grails-cache-ehcache/"
2121

2222
def license = "APACHE"
2323

0 commit comments

Comments
 (0)