diff --git a/src/libraries/System.Text.Json/src/README.md b/src/libraries/System.Text.Json/src/README.md new file mode 100644 index 0000000000000..892946041791c --- /dev/null +++ b/src/libraries/System.Text.Json/src/README.md @@ -0,0 +1,11 @@ +## About + +Provides high-performance and low-allocating types that serialize objects to JavaScript Object Notation (JSON) text and deserialize JSON text to objects, with UTF-8 support built-in. Also provides types to read and write JSON text encoded as UTF-8, and to create an in-memory document object model (DOM), that is read-only, for random access of the JSON elements within a structured view of the data. + +The `System.Text.Json` library is built-in as part of the shared framework in .NET Runtime. The package can be installed when you need to use it in other target frameworks. + +For more information, see the documentation: + +- [JSON serialization and deserialization in .NET](https://docs.microsoft.com/dotnet/standard/serialization/system-text-json-overview) +- [How to serialize and deserialize JSON in .NET](https://docs.microsoft.com/dotnet/standard/serialization/system-text-json-how-to) +- [System.Text.Json API reference](https://docs.microsoft.com/dotnet/api/system.text.json) diff --git a/src/libraries/System.Text.Json/src/System.Text.Json.csproj b/src/libraries/System.Text.Json/src/System.Text.Json.csproj index b3bf13f32cd63..4c77b86f392cd 100644 --- a/src/libraries/System.Text.Json/src/System.Text.Json.csproj +++ b/src/libraries/System.Text.Json/src/System.Text.Json.csproj @@ -12,16 +12,8 @@ true Provides high-performance and low-allocating types that serialize objects to JavaScript Object Notation (JSON) text and deserialize JSON text to objects, with UTF-8 support built-in. Also provides types to read and write JSON text encoded as UTF-8, and to create an in-memory document object model (DOM), that is read-only, for random access of the JSON elements within a structured view of the data. -Commonly Used Types: -System.Text.Json.JsonSerializer -System.Text.Json.JsonDocument -System.Text.Json.JsonElement -System.Text.Json.Utf8JsonWriter -System.Text.Json.Utf8JsonReader -System.Text.Json.Nodes.JsonNode -System.Text.Json.Nodes.JsonArray -System.Text.Json.Nodes.JsonObject -System.Text.Json.Nodes.JsonValue +The System.Text.Json library is built-in as part of the shared framework in .NET Runtime. The package can be installed when you need to use it in other target frameworks. + README.md @@ -319,6 +311,7 @@ System.Text.Json.Nodes.JsonValue +