Skip to content

Commit fc50299

Browse files
committed
docs: small readme improvements
1 parent 84e2936 commit fc50299

File tree

2 files changed

+8
-33
lines changed

2 files changed

+8
-33
lines changed

README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -28,19 +28,19 @@
2828

2929
Puma4j provides a convenient and easier way to load and parse file resources in your **JUnit 5** tests using just a couple of **annotations** :)
3030

31-
## Download
31+
## Installation
3232

33-
![Java 8](docs/assets/java.svg)
33+
![Java 8](https://img.shields.io/badge/java-8-yellow)
3434

3535
Using Gradle:
3636

37-
```
37+
```gradle
3838
testImplementation "io.github.vitorsalgado.puma4j:puma4j-junit5-extension:4.0.2"
3939
```
4040

4141
or Maven:
4242

43-
```
43+
```xml
4444
<dependency>
4545
<groupId>io.github.vitorsalgado.puma4j</groupId>
4646
<artifactId>puma4j-junit5-extension</artifactId>
@@ -68,7 +68,7 @@ First, annotate your JUnit 5 test classes with `@UsePuma4j`. Now you can use the
6868
to inject resources on class fields and/or method parameters.
6969
Take a look on the complete example below:
7070

71-
```
71+
```java
7272
@UsePuma4j
7373
class UsageWithJUnit5 {
7474

@@ -123,13 +123,13 @@ Then, use the annotation `@Use(YourCustomUnmarshaller.class)` on the class, fiel
123123

124124
You can load resources using a Kotlin delegate also. Look the example below:
125125

126-
```
126+
```kotlin
127127
private val simpleModel: SimpleModel by res("simple.json")
128128
```
129129

130130
To use the delegate `res`, add the library below to your project:
131131

132-
```
132+
```gradle
133133
testImplementation "io.github.vitorsalgado.puma4j:puma4j-kotlin:4.0.2"
134134
```
135135

@@ -141,7 +141,7 @@ See [CONTRIBUTING](CONTRIBUTING.md) for more details.
141141

142142
## Contributors
143143

144-
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
144+
Thanks goes to these wonderful people :
145145

146146
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
147147
<!-- prettier-ignore-start -->

docs/assets/java.svg

-25
This file was deleted.

0 commit comments

Comments
 (0)