Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add markdown Readme for System.Text.Json #69015

Merged
merged 11 commits into from
Jun 10, 2022
11 changes: 11 additions & 0 deletions src/libraries/System.Text.Json/src/README.md
Original file line number Diff line number Diff line change
@@ -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 for .NET Core 3.0+ and .NET 5+. The package can be installed when needing to access more recent versions of the library in older target frameworks.
eiriktsarpalis marked this conversation as resolved.
Show resolved Hide resolved

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)
13 changes: 3 additions & 10 deletions src/libraries/System.Text.Json/src/System.Text.Json.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,8 @@
<EnableAOTAnalyzer>true</EnableAOTAnalyzer>
<PackageDescription>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</PackageDescription>
The System.Text.Json library is built-in as part of the shared framework for .NET Core 3.0+ and .NET 5+. The package can be installed when needing to access more recent versions of the library in older target frameworks.</PackageDescription>
<PackageReadmeFile>README.md</PackageReadmeFile>
</PropertyGroup>

<!-- DesignTimeBuild requires all the TargetFramework Derived Properties to not be present in the first property group. -->
Expand Down Expand Up @@ -319,6 +311,7 @@ System.Text.Json.Nodes.JsonValue</PackageDescription>
<Compile Include="System\Text\Json\Writer\Utf8JsonWriter.WriteValues.UnsignedNumber.cs" />
<Compile Include="System\ReflectionExtensions.cs" />
<Compile Include="$(CommonPath)System\Obsoletions.cs" Link="Common\System\Obsoletions.cs" />
<None Include="README.md" Pack="true" PackagePath="\"/>
</ItemGroup>

<ItemGroup Condition="'$(TargetFrameworkIdentifier)' != '.NETCoreApp'">
Expand Down