diff --git a/docs/README.md b/docs/README.md index 0e2f38d6..411c479e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,15 +1,18 @@ -# ASP.NET Core on .NET +# Documentation -ServiceComposer leverages the Endpoints support to plugin into the request handling pipeline. -ServiceComposer can be added to existing or new ASP.NET Core projects, or it can be hosted in .NET console applications. +The [getting started](getting-started.md) documentation provides an overview of the basic building blocks: + +- [Hosting](getting-started.md) +- [Composition requests handlers](getting-started.md#composition-requests-handlers) +- [Composition events handlers](getting-started.md#composition-events-handlers) ## Supported .NET versions ServiceComposer targets .NET 8. -## Note about thread safety - -If resources are shared across more than one handler they must be [thread-safe](thread-safety.md). +> [!NOTE] +> About thread safety +> If resources are shared across more than one handler they must be [thread-safe](thread-safety.md). ## Upgrade guides diff --git a/docs/getting-started.md b/docs/getting-started.md new file mode 100644 index 00000000..c5e33e0f --- /dev/null +++ b/docs/getting-started.md @@ -0,0 +1,9 @@ +# Getting started + +## Hosting + +ServiceComposer leverages the ASP.NET Core Endpoints support to plugin into the request handling pipeline. ServiceComposer can be added to existing or new ASP.NET Core projects, or it can be hosted standalone in .NET console applications. + +## Composition requests handlers + +## Composition events handlers