Skip to content

Commit e3c4bb5

Browse files
committed
docs: normalise caching package READMEs
1 parent 39bce51 commit e3c4bb5

3 files changed

Lines changed: 12 additions & 24 deletions

File tree

src/SquidStd.Caching.Abstractions/README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,6 @@ backend implementation (in-memory or Redis) from a companion package.
2222
dotnet add package SquidStd.Caching.Abstractions
2323
```
2424

25-
## Features
26-
27-
- `ICacheService` — typed `GetAsync<T>` / `SetAsync<T>` / `RemoveAsync` / `ExistsAsync` / `GetOrSetAsync<T>` facade.
28-
- `ICacheProvider` — the raw byte-level backend contract implemented per provider.
29-
- `CacheService` — shared facade that serializes values, applies the key prefix and default TTL, and implements cache-aside.
30-
- `ICacheMetrics` (+ `CacheMetricsProvider`, `NoOpCacheMetrics`) — hit/miss/set/remove metrics.
31-
- `CacheOptions` and `CacheConnectionString` — configuration and connection parsing.
32-
3325
## Usage
3426

3527
```csharp
@@ -51,6 +43,10 @@ public Task<int> GetOrComputeAsync(ICacheService cache)
5143
| `CacheOptions` | Default TTL and key prefix. |
5244
| `CacheConnectionString` | `scheme://host[?params]` parsing into `CacheOptions`. |
5345

46+
## Related
47+
48+
- Tutorial: [Caching](https://tgiachi.github.io/squid-std/tutorials/caching.html)
49+
5450
## License
5551

5652
MIT — part of [SquidStd](https://github.com/tgiachi/squid-std).

src/SquidStd.Caching.Redis/README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,6 @@ Registered with a single `AddRedisCache(...)` call.
2121
dotnet add package SquidStd.Caching.Redis
2222
```
2323

24-
## Features
25-
26-
- One-line registration: `container.AddRedisCache(connectionString)` or with `RedisCacheOptions`.
27-
- Redis-backed `ICacheProvider` reusing the shared `ICacheService` facade and serializer.
28-
- Native TTL via Redis key expiry (`SET ... EX`).
29-
- Connection via a `redis://` connection string or an explicit StackExchange.Redis configuration string.
30-
- Built-in hit/miss metrics via `CacheMetricsProvider`.
31-
3224
## Usage
3325

3426
```csharp
@@ -52,6 +44,10 @@ var user = await cache.GetAsync<object>("user:1");
5244
| `RedisCacheProvider` | StackExchange.Redis-backed `ICacheProvider`. |
5345
| `RedisCacheOptions` | StackExchange.Redis connection configuration. |
5446

47+
## Related
48+
49+
- Tutorial: [Caching](https://tgiachi.github.io/squid-std/tutorials/caching.html)
50+
5551
## License
5652

5753
MIT — part of [SquidStd](https://github.com/tgiachi/squid-std).

src/SquidStd.Caching/README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,6 @@ single `AddInMemoryCache()` call. Ideal for single-process apps, tests, and loca
2121
dotnet add package SquidStd.Caching
2222
```
2323

24-
## Features
25-
26-
- One-line registration: `container.AddInMemoryCache()` (provider, facade, serializer, metrics).
27-
- `IMemoryCache`-backed storage with absolute per-entry TTL and built-in eviction.
28-
- Reuses the shared `CacheService` facade (key prefix, default TTL, cache-aside).
29-
- Built-in hit/miss metrics via `CacheMetricsProvider`.
30-
- Configure via `CacheOptions` or a `memory://` connection string (`?defaultTtlSeconds=`, `?keyPrefix=`).
31-
3224
## Usage
3325

3426
```csharp
@@ -51,6 +43,10 @@ var user = await cache.GetAsync<object>("user:1");
5143
| `CacheRegistrationExtensions` | `AddInMemoryCache(...)` registration. |
5244
| `InMemoryCacheProvider` | `IMemoryCache`-backed `ICacheProvider`. |
5345

46+
## Related
47+
48+
- Tutorial: [Caching](https://tgiachi.github.io/squid-std/tutorials/caching.html)
49+
5450
## License
5551

5652
MIT — part of [SquidStd](https://github.com/tgiachi/squid-std).

0 commit comments

Comments
 (0)