Skip to content

Commit a369fbd

Browse files
Readmes for HTTP and Site Extensions (#31250)
* Readmes for HTTP and Site Extensions * Apply suggestions from code review Co-authored-by: Brennan <[email protected]> Co-authored-by: Brennan <[email protected]>
1 parent 1abdc61 commit a369fbd

File tree

2 files changed

+61
-4
lines changed

2 files changed

+61
-4
lines changed

src/Http/README.md

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,37 @@
1-
Http Abstractions
2-
=================
1+
# Http
32

4-
This folders contains projects for HTTP abstractions for ASP.NET Core such as `HttpContext`, `HttpRequest`, `HttpResponse` and `RequestDelegate`.
3+
Http is a collection of HTTP abstractions used in ASP.NET Core, such as `HttpContext`, `HttpRequest`, `HttpResponse` and `RequestDelegate`.
54

6-
It also contains `IApplicationBuilder` and extensions to create and compose your application's pipeline.
5+
It also includes `Endpoint Routing` and `WebUtilities`.
6+
7+
## Description
8+
9+
The following contains a description of each sub-directory in the `Http` directory.
10+
11+
- [Authentication.Abstractions/](Authentication.Abstractions/): Contains common types used by the various authentication components.
12+
- [Authentication.Core/](Authentication.Core/): Contains common types used by the various authentication middleware components.
13+
- [Headers/](Headers/): Contains headers and header parser implementations.
14+
- [Http/](Http/): Contains default HTTP feature implementations.
15+
- [Http.Abstractions/](Http.Abstractions/): Contains HTTP object model for HTTP requests and responses and also common extension methods for registering middleware in an IApplicationBuilder.
16+
- [Http.Extensions/](Http.Extensions/): Contains common extension methods for HTTP abstractions, HTTP headers, HTTP request/response, and session state.
17+
- [Http.Features/](Http.Features/): Contains HTTP feature interface definitions.
18+
- [Metadata/](Metadata/): Contains ASP.NET Core metadata.
19+
- [Owin/](Owin/): Contains components for running OWIN middleware in an ASP.NET Core application, and to run ASP.NET Core middleware in an OWIN application.
20+
- [Routing/](Routing/): Contains middleware for routing requests to application logic and for generating links.
21+
- [Routing.Abstractions/](Routing.Abstractions/): Contains abstractions for routing requests to application logic and for generating links.
22+
- [WebUtilities/](WebUtilities/): Contains utilities, for working with forms, multipart messages, and query strings.
23+
- [samples/](samples/): Contains samples.
24+
25+
## Development Setup
26+
27+
### Build
28+
29+
To build this specific project from source, follow the instructions [on building a subset of the code](../../docs/BuildFromSource.md#building-a-subset-of-the-code).
30+
31+
### Test
32+
33+
To run the tests for this project, [run the tests on the command line](../../docs/BuildFromSource.md#running-tests-on-command-line) in this directory.
34+
35+
## More Information
36+
37+
For more information, see the [ASP.NET Core README](../../README.md).

src/SiteExtensions/README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# SiteExtensions
2+
3+
Site extensions are extensions specific to Azure App Services.
4+
5+
## Description
6+
7+
The following contains a description of each sub-directory in the `SiteExtensions` directory.
8+
9+
- `LoggingAggregate`: Site extensions for logging integration for ASP.NET Core applications on Azure App Service.
10+
- `LoggingBranch`: Site extension which enables additional functionality for ASP.NET Core on Azure WebSites, such as enabling Azure logging.
11+
- `Runtime`: This site extension installs Microsoft.AspNetCore.App and Microsoft.NetCore.App shared runtimes.
12+
13+
## Development Setup
14+
15+
### Build
16+
17+
To build this specific project from source, follow the instructions [on building a subset of the code](../../docs/BuildFromSource.md#building-a-subset-of-the-code).
18+
19+
Or for the less detailed explanation, run the following command inside this directory.
20+
```powershell
21+
> ./build.cmd
22+
```
23+
24+
## More Information
25+
26+
For more information, see the [ASP.NET Core README](../../README.md).

0 commit comments

Comments
 (0)