Skip to content

Commit

Permalink
doc: improve readme and increasing version
Browse files Browse the repository at this point in the history
  • Loading branch information
gustavoleitao committed Oct 6, 2022
1 parent 417b489 commit db527f9
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,16 @@ This project implements queries filter in generic way to REST APIs developed wit

This project is currently in developing mode. We don`t release stable version yet. Watch this project to follow its development.

To install use this entry in Maven project:

```
<dependency>
<groupId>io.github.gustavoleitao</groupId>
<artifactId>query-api</artifactId>
<version>0.0.2-beta</version>
</dependency>
```

## How to use

First step you need to add @RequestParam Map<String, String> at Controller method to collect all request parameters. After that, you need to create instance of QuerySpecification and pass this parameter to repository query, like this:
Expand Down Expand Up @@ -130,3 +140,11 @@ public class GrettingController {
}
}
```

### Genareting new version

Use the following command to generate a new version

```
./mvnw clean deploy -P release
```
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@

<groupId>io.github.gustavoleitao</groupId>
<artifactId>query-api</artifactId>
<version>0.0.1-beta</version>
<version>0.0.2-beta</version>
<name>query-api</name>
<packaging>jar</packaging>

Expand Down

0 comments on commit db527f9

Please sign in to comment.