Add markdown readme for System.Collections.Immutable (#71247)

MSDN-WhiteKnight · web-flow · commit 21a69aa7f70c · 2022-07-07T15:16:02.000+01:00
* Update System.Collections.Immutable.csproj

* Add README.md

* Add README.md

* Delete README.md

* Update PackageDescription
diff --git a/src/libraries/System.Collections.Immutable/src/README.md b/src/libraries/System.Collections.Immutable/src/README.md
@@ -0,0 +1,10 @@
+## About
+
+This package provides collections that are thread safe and guaranteed to never change their contents, also known as immutable collections. Like strings, any methods that perform modifications will not change the existing instance but instead return a new instance. For efficiency reasons, the implementation uses a sharing mechanism to ensure that newly created instances share as much data as possible with the previous instance while ensuring that operations have a predictable time complexity.
+
+The `System.Collections.Immutable` 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:
+
+- [Collections and Data Structures](https://docs.microsoft.com/dotnet/standard/collections/)
+- [System.Collections.Immutable API reference](https://docs.microsoft.com/dotnet/api/system.collections.immutable)
diff --git a/src/libraries/System.Collections.Immutable/src/System.Collections.Immutable.csproj b/src/libraries/System.Collections.Immutable/src/System.Collections.Immutable.csproj
@@ -4,23 +4,8 @@
     <IsPackable>true</IsPackable>
     <PackageDescription>This package provides collections that are thread safe and guaranteed to never change their contents, also known as immutable collections. Like strings, any methods that perform modifications will not change the existing instance but instead return a new instance. For efficiency reasons, the implementation uses a sharing mechanism to ensure that newly created instances share as much data as possible with the previous instance while ensuring that operations have a predictable time complexity.
 
-Commonly Used Types:
-System.Collections.Immutable.ImmutableArray
-System.Collections.Immutable.ImmutableArray&lt;T&gt;
-System.Collections.Immutable.ImmutableDictionary
-System.Collections.Immutable.ImmutableDictionary&lt;TKey,TValue&gt;
-System.Collections.Immutable.ImmutableHashSet
-System.Collections.Immutable.ImmutableHashSet&lt;T&gt;
-System.Collections.Immutable.ImmutableList
-System.Collections.Immutable.ImmutableList&lt;T&gt;
-System.Collections.Immutable.ImmutableQueue
-System.Collections.Immutable.ImmutableQueue&lt;T&gt;
-System.Collections.Immutable.ImmutableSortedDictionary
-System.Collections.Immutable.ImmutableSortedDictionary&lt;TKey,TValue&gt;
-System.Collections.Immutable.ImmutableSortedSet
-System.Collections.Immutable.ImmutableSortedSet&lt;T&gt;
-System.Collections.Immutable.ImmutableStack
-System.Collections.Immutable.ImmutableStack&lt;T&gt;</PackageDescription>
+The System.Collections.Immutable 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.</PackageDescription>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
 
   <ItemGroup>
@@ -104,6 +89,7 @@ System.Collections.Immutable.ImmutableStack&lt;T&gt;</PackageDescription>
     <Compile Include="$(CommonPath)System\Runtime\Versioning\NonVersionableAttribute.cs"
              Link="Common\System\Runtime\Versioning\NonVersionableAttribute.cs" />
     <None Include="Interfaces.cd" />
+    <None Include="README.md" Pack="true" PackagePath="\"/>
   </ItemGroup>
 
   <ItemGroup Condition="'$(TargetFramework)' == '$(NetCoreAppCurrent)'">
