Skip to content

Commit 160821d

Browse files
committed
Update README and contributing docs for multitenancy
Added shipped status and getting started instructions for the Multitenancy core extension in the README. Updated documentation links to use Markdown format and clarified link formatting guidelines in the contributing guide.
1 parent e538fc1 commit 160821d

2 files changed

Lines changed: 27 additions & 5 deletions

File tree

README.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,12 @@ Quick links:
2020
## Status
2121

2222
- Shipped: `CleanArchitecture.Extensions.Caching` (net10.0)
23-
- Planned: Multitenancy core and adapters
23+
- Shipped: `CleanArchitecture.Extensions.Multitenancy` (core, host-agnostic, net10.0)
24+
- Planned: Multitenancy adapters (AspNetCore, EFCore, Identity, Provisioning, Redis, Sharding, Storage)
2425

25-
## Getting started (caching)
26+
## Getting started
27+
28+
### Caching
2629

2730
1. Install:
2831
```powershell
@@ -36,11 +39,29 @@ Quick links:
3639
3. Configure caching options as needed.
3740
4. No other template changes required.
3841

42+
### Multitenancy core
43+
44+
1. Install:
45+
```powershell
46+
dotnet add src/Application/Application.csproj package CleanArchitecture.Extensions.Multitenancy
47+
dotnet add src/Infrastructure/Infrastructure.csproj package CleanArchitecture.Extensions.Multitenancy
48+
```
49+
2. Register:
50+
```csharp
51+
services.AddCleanArchitectureMultitenancy();
52+
```
53+
3. Resolve tenants in your host and set the current context (host adapter required).
54+
4. Add pipeline behaviors:
55+
```csharp
56+
services.AddMediatR(cfg => cfg.AddCleanArchitectureMultitenancyPipeline());
57+
```
58+
3959
Docs to read next:
4060

41-
- Caching overview: https://cleanarchitecture-extensions.github.io/CleanArchitecture.Extensions/extensions/caching/
42-
- Extensions catalog: https://cleanarchitecture-extensions.github.io/CleanArchitecture.Extensions/extensions/
43-
- Roadmap: https://cleanarchitecture-extensions.github.io/CleanArchitecture.Extensions/roadmap/
61+
- [Caching overview](https://cleanarchitecture-extensions.github.io/CleanArchitecture.Extensions/extensions/caching/)
62+
- [Multitenancy core overview](https://cleanarchitecture-extensions.github.io/CleanArchitecture.Extensions/extensions/multitenancy-core/)
63+
- [Extensions catalog](https://cleanarchitecture-extensions.github.io/CleanArchitecture.Extensions/extensions/)
64+
- [Roadmap](https://cleanarchitecture-extensions.github.io/CleanArchitecture.Extensions/roadmap/)
4465

4566
## Repo layout
4667

docs/contributing/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,4 @@ We keep the upstream Jason Taylor template pristine and ship everything as opt-i
2727
- Use fenced code blocks with language tags (`bash`, `powershell`, `csharp`, `json`).
2828
- Prefer snippets from source to avoid drift; keep examples short and runnable.
2929
- Keep compatibility info current (template version, target frameworks, dependencies).
30+
- Format external links as Markdown links, for example `- [Roadmap](https://cleanarchitecture-extensions.github.io/CleanArchitecture.Extensions/roadmap/)` (avoid `Label: URL`).

0 commit comments

Comments
 (0)