Skip to content

Commit

Permalink
Provide Microsoft.AspNetCore.Diagnostics.EntityFramework package RE…
Browse files Browse the repository at this point in the history
…ADME (#57540)
  • Loading branch information
MackinnonBuck authored Aug 28, 2024
1 parent c9dee16 commit 36a2dfd
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions src/Middleware/Diagnostics.EntityFrameworkCore/src/PACKAGE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
## About

`Microsoft.AspNetCore.Diagnostics.EntityFramework` provides an ASP.NET Core middleware for EF Core error pages, allowing detection and diagnosis of errors with EF Core migrations.

## Key Features

* Captures and displays detailed error information from Entity Framework Core database operations
* Helps developers diagnose and troubleshoot database-related issues in ASP.NET Core applications

## How to Use

To use `Microsoft.AspNetCore.Diagnostics.EntityFramework`, follow these steps:

### Installation

```shell
dotnet add package Microsoft.AspNetCore.Diagnostics.EntityFramework
```

### Configuration

To use the middleware, add it to the ASP.NET Core pipeline defined in your app's `Program.cs`:

```csharp
builder.Services.AddDatabaseDeveloperPageExceptionFilter();

var app = builder.build();

if (app.Environment.IsDevelopment())
{
app.UseDeveloperExceptionPage();
app.UseMigrationsEndPoint();
}
```

## Additional Documentation

For more information on using Entity Framework Core in ASP.NET Core applications, refer to the [official documentation](https://learn.microsoft.com/aspnet/core/data/ef-rp/intro).

## Feedback & Contributing

`Microsoft.AspNetCore.Diagnostics.EntityFramework` is released as open-source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/aspnetcore).

0 comments on commit 36a2dfd

Please sign in to comment.