diff --git a/src/libraries/System.IO.Pipelines/src/PACKAGE.md b/src/libraries/System.IO.Pipelines/src/PACKAGE.md index 2bf8184f1c3b6..8f3ac7aaeb703 100644 --- a/src/libraries/System.IO.Pipelines/src/PACKAGE.md +++ b/src/libraries/System.IO.Pipelines/src/PACKAGE.md @@ -2,43 +2,48 @@ +A library designed to make it easier to do high-performance I/O. +Apps that parse streaming data are composed of boilerplate code having many specialized and unusual code flows. +The boilerplate and special case code is complex and difficult to maintain. + +`System.IO.Pipelines` was architected to: + +* Have high performance parsing streaming data. +* Reduce code complexity. ## Key Features -* -* -* +* Single producer/single consumer byte buffer management. +* Reduction in code complexity and boilerplate code associated with I/O operations. ## How to Use +Check the [System.IO.Pipelines in .NET article](https://learn.microsoft.com/dotnet/standard/io/pipelines) for a full example. + ## Main Types The main types provided by this library are: -* `` -* `` -* `` +* `System.IO.Pipelines.Pipe` +* `System.IO.Pipelines.PipeWriter` +* `System.IO.Pipelines.PipeReader` ## Additional Documentation -* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) - -## Related Packages - - +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/io/pipelines) +* [API documentation](https://learn.microsoft.com/dotnet/api/system.io.pipelines) ## Feedback & Contributing -System.IO.Pipelines 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/runtime). \ No newline at end of file +System.IO.Pipelines 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/runtime).