From 5efc1bb8cab465ab5d0ff629b72ebaf0e70e96d0 Mon Sep 17 00:00:00 2001 From: "MSDN.WhiteKnight" <35516665+MSDN-WhiteKnight@users.noreply.github.com> Date: Fri, 10 Jun 2022 15:57:00 +0500 Subject: [PATCH] Add markdown Readme for System.Text.Json (#69015) * Update project * Create readme.md * Fix typo * Update src/libraries/System.Text.Json/src/readme.md Co-authored-by: Eirik Tsarpalis * Delete readme.md * Rename readme file * Add more docs links * Fix link * Update PackageDescription * Apply suggestions from code review Co-authored-by: Eirik Tsarpalis Co-authored-by: Viktor Hofer * Remove mentions of exact target framework versions Co-authored-by: Eirik Tsarpalis Co-authored-by: Viktor Hofer --- src/libraries/System.Text.Json/src/README.md | 11 +++++++++++ .../System.Text.Json/src/System.Text.Json.csproj | 13 +++---------- 2 files changed, 14 insertions(+), 10 deletions(-) create mode 100644 src/libraries/System.Text.Json/src/README.md 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 8ecdb514ad65b..0e4522699262a 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 +