Skip to content

Commit 04fa402

Browse files
committed
Update README.md
1 parent 17d5cee commit 04fa402

File tree

1 file changed

+5
-30
lines changed

1 file changed

+5
-30
lines changed

README.md

Lines changed: 5 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
[![Build & Deploy](https://github.com/intellinside/spring-cache-tags/actions/workflows/release.yml/badge.svg)](https://github.com/intellinside/spring-cache-tags/actions/workflows/release.yml)
44
[![Maven Central](https://img.shields.io/maven-central/v/io.github.intellinside/spring-cache-tags.svg?style=flat-square)](https://search.maven.org/artifact/io.github.intellinside/spring-cache-tags)
5+
[![javadoc](https://javadoc.io/badge2/io.github.intellinside/spring-cache-tags/javadoc.svg)](https://javadoc.io/doc/io.github.intellinside/spring-cache-tags)
6+
57

68
**Spring Cache Tags** is a lightweight library for managing Spring Cache using tags.
79
It allows you to group cached methods by tags and evict cache entries by one or multiple tags at once.
810

9-
---
10-
1111
## Features
1212

1313
- 🏷️ Tag your cacheable methods with `@CacheTags` and evict tagged cache entries with `@EvictTags`
@@ -18,8 +18,6 @@ It allows you to group cached methods by tags and evict cache entries by one or
1818
- 🔒 Thread-safe operations with concurrent access support
1919
- 📦 Automatic Spring Boot auto-configuration
2020

21-
---
22-
2321
## Quick Start
2422

2523
### Installation
@@ -29,13 +27,13 @@ It allows you to group cached methods by tags and evict cache entries by one or
2927
<dependency>
3028
<groupId>io.github.intellinside</groupId>
3129
<artifactId>spring-boot-starter-cache-tags</artifactId>
32-
<version>1.0.0</version>
30+
<version>0.1.0</version>
3331
</dependency>
3432
```
3533

3634
#### Gradle
3735
```groovy
38-
implementation 'io.github.intellinside:spring-boot-starter-cache-tags:1.0.0'
36+
implementation 'io.github.intellinside:spring-boot-starter-cache-tags:0.1.0'
3937
```
4038

4139
### Basic Example
@@ -58,8 +56,6 @@ public class UserService {
5856
}
5957
```
6058

61-
---
62-
6359
## Core Concepts
6460

6561
### Tags with @CacheTags
@@ -102,8 +98,6 @@ public Product updateProduct(Long productId, String category) {
10298
}
10399
```
104100

105-
---
106-
107101
## Storage Backends
108102

109103
### In-Memory Storage (Default)
@@ -158,8 +152,6 @@ SET tag:user:123 users:permissions:123
158152
SET tag:admin admins:settings:456
159153
```
160154

161-
---
162-
163155
## Advanced Usage
164156

165157
### Complex Tag Expressions
@@ -222,16 +214,12 @@ public User getUserWithRoleAndDepartment(Long id) {
222214
}
223215
```
224216

225-
---
226-
227217
## Configuration
228218

229219
### Spring Boot Auto-Configuration
230220

231221
The library automatically configures itself with Spring Boot. No additional configuration is needed for basic functionality.
232222

233-
---
234-
235223
## Performance Considerations
236224

237225
### In-Memory Storage
@@ -251,8 +239,6 @@ The library automatically configures itself with Spring Boot. No additional conf
251239
4. Monitor memory usage in in-memory mode
252240
5. Use Redis for production distributed systems
253241

254-
---
255-
256242
## Troubleshooting
257243

258244
### Tags are not being recorded
@@ -279,39 +265,28 @@ The library automatically configures itself with Spring Boot. No additional conf
279265
3. Monitor and clean up unused cache entries
280266
4. Review SpEL expressions for correctness
281267

282-
---
283-
284268
## Requirements
285269

286270
- **Java**: 21 or higher
287271
- **Spring Framework**: 6.x
288272
- **Spring Boot**: 3.x (optional, for auto-configuration)
289273

290-
291-
---
292-
293274
## Contributing
294275

295276
Contributions are welcome! Please feel free to submit a Pull Request.
296277

297-
---
298-
299278
## License
300279

301280
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
302281

303-
---
304-
305282
## Support & Documentation
306283

307284
- 📖 [API Documentation](https://javadoc.io/doc/io.github.intellinside/spring-cache-tags)
308285
- 🐛 [Issue Tracker](https://github.com/intellinside/spring-cache-tags/issues)
309286

310-
---
311-
312287
## Changelog
313288

314-
### Version 1.0.0
289+
### Version 0.1.0
315290
- Initial release
316291
- Support for @CacheTags and @EvictTags annotations
317292
- In-Memory and Redis storage backends

0 commit comments

Comments
 (0)