Skip to content

Commit

Permalink
Add getting started examples
Browse files Browse the repository at this point in the history
  • Loading branch information
Psypher9 committed Aug 18, 2023
1 parent 878599e commit c2b91de
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,27 @@
# BasicRepos
A project to build .NET repository services more quickly

## Getting Started

To add Basic Repositories to your service collection simply use `AddBasicRepos<TDbContext>()` on the Service Collection. For example:

```csharp
builder.Services.AddBasicRepos<MyDbContext>();
```

This will add a repository registration for every `DbSet<T>` on the target `DbContext`.

> To add support for `DbSet<T>`s in another `DbContext`, simply call `AddBasicRepos<TDbContext>()` again with the second type.
>
> For example:
>
> ```csharp
> builder.Services.AddBasicRepos<MyDbContext>()
> .AddBasicRepos<MyOtherDbContext>();
> ```
Using `AddBasicRepos<MyDbContext>()` will register each of the following repository types for each `DbSet<T>`:
- `IRepository<T>`: repository with read and write abilities on the underlying data store, with no cache
- `IReadOnlyRepository<T>`: repository with only the ability to read from the underlying data store
- `ICachedRepository<T>`: repository which wraps an in-memory cache of the items it manages

0 comments on commit c2b91de

Please sign in to comment.