From 973c6155b263a99b56ab2003524e6f8b12c67210 Mon Sep 17 00:00:00 2001 From: Koen Bekkenutte <2912652+kbekkenutte@users.noreply.github.com> Date: Wed, 2 Jun 2021 01:45:25 +0800 Subject: [PATCH] Added a getting started section --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 13f6a60..bf118bf 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,10 @@ Flexible projection magic for EFCore - EntityFrameworkCore.Projectables [![NuGet version](https://img.shields.io/nuget/v/EntityFrameworkCore.Projectables.svg?style=flat-square)](https://www.nuget.org/packages/EntityFrameworkCore.Projectables/) [![NuGet](https://img.shields.io/nuget/dt/EntityFrameworkCore.Projectables.svg?style=flat-square)](https://www.nuget.org/packages/EntityFrameworkCore.Projectables/) ## Getting started -TODO +1. Install the package from [NuGet](https://www.nuget.org/packages/EntityFrameworkCore.Projectables/) +2. Enable Projectables in your DbContext by calling: `dbContextOptions.UseProjectables()` +3. Implement projectable properties and methods and mark them with the [Projectable] attribute. +4. View our [samples](https://github.com/koenbeuk/EntityFrameworkCore.Projectables/tree/master/samples) ### Example Assuming this sample: