Skip to content

Commit

Permalink
changed readme, added compatibility
Browse files Browse the repository at this point in the history
  • Loading branch information
aleksadacic committed Jan 30, 2025
1 parent b7657aa commit 71fdc82
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 5 deletions.
10 changes: 10 additions & 0 deletions COMPATIBILITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Compatibility Matrix

| Spring Data JPA | Spring Framework | Spring Boot | Java Version | Jakarta Persistence |
|-----------------|------------------|-------------|--------------|---------------------|
| 3.4.2 | 6.2.2+ | 3.4.2+ | 17 - 23 | 3.2.0+ |
| 3.3.x | 6.1.x | 3.3.x | 17 - 21 | 3.1.0+ |
| 3.2.x | 6.0.x | 3.2.x | 17 - 21 | 3.0.0+ |

> [!NOTE]
> This project does **not** support Spring Boot 2.x or Java versions below 17.
28 changes: 23 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ and `SearchOperator`.
## Table of Contents

- [Features](#features)
- [Compatibility](#compatibility)
- [Installation](#installation)
- [Quick Start](#quick-start)
- [Core Concepts](#core-concepts)
Expand All @@ -26,16 +27,31 @@ and `SearchOperator`.
## Features

- **Dynamic Query Building**: Create complex JPA queries with an intuitive, fluent API.
- **Nested Filters**: Build recursive AND/OR conditions through `SearchRequest`.
- **Minimal Boilerplate**: No need to hand-write every `specification<T>` --the library does it for you.
- **Integration with Spring Data**: Seamlessly use `specification<T>`, `Pageable`, etc.
- **Search request DTO** for your endpoints out of the box which you can convert to `Specification` object.
- **Nested Filters**: Build recursive AND/OR conditions.
- **Multiple Joins**: Deep join. Filter by your joined attribute (e.g. user.card.bank.bankName).
- **Minimal Boilerplate**: No need to hand-write every `Specification` --the library does it for you.
- **Projections** simplified. No need to write `@Query` in your repository, just provide a POJO.
- **Integration with Spring Data**: Seamlessly use `Specification`, `Pageable`, etc.

## Compatibility

This library is compatible with:

- **Spring Framework**: 6.2.2+
- **Spring Boot**: 3.4.2+
- **Java Version**: 17 - 23

For more compatibility details
visit [this page](https://github.com/aleksadacic/DataQuerying/blob/master/COMPATIBILITY.md).

## Installation

<details>
<summary>Maven</summary>

```xml

<dependency>
<groupId>io.github.aleksadacic.dataquerying</groupId>
<artifactId>DataQuerying</artifactId>
Expand Down Expand Up @@ -298,8 +314,10 @@ errors in your REST APIs.

## Contributing

Contributions are encouraged and accepted. To view more information about contributon visit [this page](https://github.com/aleksadacic/DataQuerying/blob/master/CONTRIBUTING.md).
Contributions are encouraged and accepted. To view more information about contributon
visit [this page](https://github.com/aleksadacic/DataQuerying/blob/master/CONTRIBUTING.md).

## License

This project is licensed under the [Apache-2.0 license](LICENSE.txt). Feel free to modify and distribute under these terms.
This project is licensed under the [Apache-2.0 license](LICENSE.txt). Feel free to modify and distribute under these
terms.

0 comments on commit 71fdc82

Please sign in to comment.