Skip to content

Commit 20b194b

Browse files
committed
Update READMEs
1 parent 4ecc256 commit 20b194b

File tree

2 files changed

+53
-8
lines changed

2 files changed

+53
-8
lines changed

README.md

Lines changed: 35 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,39 +9,66 @@ A small library of (hopefully) useful Java classes.
99
[![Javadoc](https://javadoc.io/badge2/org.leplus/ristretto/javadoc.svg)](https://javadoc.io/doc/org.leplus/ristretto)
1010
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/10084/badge)](https://bestpractices.coreinfrastructure.org/projects/10084)
1111
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/leplusorg/ristretto/badge)](https://securityscorecards.dev/viewer/?uri=github.com/leplusorg/ristretto)
12+
[![Maven Site](https://img.shields.io/badge/Maven%20Site)](https://leplusorg.github.io/ristretto)
1213

13-
[Maven Site](https://leplusorg.github.io/ristretto)
14+
## Maven Coordinates
1415

15-
## Installation
16-
17-
### Maven
16+
### Apache Maven
1817

1918
```xml
2019
<dependency>
2120
<groupId>org.leplus</groupId>
2221
<artifactId>ristretto</artifactId>
23-
<version>1.0.3</version>
22+
<version>2.0.0</version>
23+
</dependency>
24+
```
25+
26+
### Apache Ivy
27+
28+
```xml
29+
<dependency org="org.leplus" name="ristretto" rev="2.0.0">
30+
<artifact name="ristretto" type="jar" />
2431
</dependency>
2532
```
2633

27-
### Gradle
34+
### Groovy Grape
35+
36+
```groovy
37+
@Grapes(
38+
@Grab(group='org.leplus', module='ristretto', version='2.0.0')
39+
)
40+
```
41+
42+
### Gradle/Grails
2843

2944
If you use ristretto in your implementation only:
3045

3146
```gradle
3247
dependencies {
33-
implementation("org.leplus:ristretto:1.0.3")
48+
implementation 'org.leplus:ristretto:2.0.0'
3449
}
3550
```
3651

3752
If you expose ristretto types in your public API:
3853

3954
```gradle
4055
dependencies {
41-
api("org.leplus:ristretto:1.0.3")
56+
api("org.leplus:ristretto:2.0.0")
4257
}
4358
```
4459

60+
### Scala SBT
61+
62+
```scala
63+
libraryDependencies += "org.leplus" % "ristretto" % "2.0.0"
64+
```
65+
66+
### Leiningen
67+
68+
```clojure
69+
[org.leplus/ristretto "2.0.0"]
70+
```
71+
4572
## Usage
4673

4774
### [org.leplus.ristretto.util.UUIDConvertor](https://javadoc.io/doc/org.leplus/ristretto/latest/org/leplus/ristretto/util/UUIDConvertor.html)

docs/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Documentation
2+
3+
See the [Maven Site](https://leplusorg.github.io/ristretto) for the
4+
detailed documentation of the library.
5+
6+
## License
7+
8+
Copyright 2016-present Thomas Leplus
9+
10+
Licensed under the Apache License, Version 2.0 (the "License");
11+
you may not use this file except in compliance with the License.
12+
You may obtain a copy of the License at
13+
<http://www.apache.org/licenses/LICENSE-2.0>.
14+
Unless required by applicable law or agreed to in writing, software
15+
distributed under the License is distributed on an "AS IS" BASIS,
16+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17+
See the License for the specific language governing permissions and
18+
limitations under the License.

0 commit comments

Comments
 (0)