Skip to content

Commit e126656

Browse files
ViktorHoferViktorHofer
committed
Add package readmes
1 parent 542a7df commit e126656

File tree

97 files changed

+4180
-127
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

97 files changed

+4180
-127
lines changed

‎src/libraries/Microsoft.Bcl.AsyncInterfaces/src/PACKAGE.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## About
2+
3+
<!-- A description of the package and where one can find more documentation -->
4+
5+
6+
7+
## Key Features
8+
9+
<!-- The key features of this package -->
10+
11+
*
12+
*
13+
*
14+
15+
## How to Use
16+
17+
<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
18+
19+
## Main Types
20+
21+
<!-- The main types provided in this library -->
22+
23+
The main types provided by this library are:
24+
25+
* ``
26+
* ``
27+
* ``
28+
29+
## Addtional Documentation
30+
31+
<!-- Links to further documentation. Remove conceptual documentation if not available for the library. -->
32+
33+
* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview)
34+
* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**)
35+
36+
## Related Packages
37+
38+
<!-- The related packages associated with this package -->
39+
40+
## Feedback & Contributing
41+
42+
<!-- How to provide feedback on this package and contribute to it -->
43+
44+
Microsoft.Bcl.AsyncInterfaces 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).

‎src/libraries/Microsoft.Bcl.Cryptography/src/PACKAGE.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## About
2+
3+
<!-- A description of the package and where one can find more documentation -->
4+
5+
6+
7+
## Key Features
8+
9+
<!-- The key features of this package -->
10+
11+
*
12+
*
13+
*
14+
15+
## How to Use
16+
17+
<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
18+
19+
## Main Types
20+
21+
<!-- The main types provided in this library -->
22+
23+
The main types provided by this library are:
24+
25+
* ``
26+
* ``
27+
* ``
28+
29+
## Addtional Documentation
30+
31+
<!-- Links to further documentation. Remove conceptual documentation if not available for the library. -->
32+
33+
* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview)
34+
* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**)
35+
36+
## Related Packages
37+
38+
<!-- The related packages associated with this package -->
39+
40+
## Feedback & Contributing
41+
42+
<!-- How to provide feedback on this package and contribute to it -->
43+
44+
Microsoft.Bcl.Cryptography 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).

‎src/libraries/Microsoft.Bcl.Numerics/src/PACKAGE.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## About
2+
3+
<!-- A description of the package and where one can find more documentation -->
4+
5+
6+
7+
## Key Features
8+
9+
<!-- The key features of this package -->
10+
11+
*
12+
*
13+
*
14+
15+
## How to Use
16+
17+
<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
18+
19+
## Main Types
20+
21+
<!-- The main types provided in this library -->
22+
23+
The main types provided by this library are:
24+
25+
* ``
26+
* ``
27+
* ``
28+
29+
## Addtional Documentation
30+
31+
<!-- Links to further documentation. Remove conceptual documentation if not available for the library. -->
32+
33+
* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview)
34+
* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**)
35+
36+
## Related Packages
37+
38+
<!-- The related packages associated with this package -->
39+
40+
## Feedback & Contributing
41+
42+
<!-- How to provide feedback on this package and contribute to it -->
43+
44+
Microsoft.Bcl.Numerics 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).

‎src/libraries/Microsoft.Bcl.TimeProvider/src/PACKAGE.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## About
2+
3+
<!-- A description of the package and where one can find more documentation -->
4+
5+
6+
7+
## Key Features
8+
9+
<!-- The key features of this package -->
10+
11+
*
12+
*
13+
*
14+
15+
## How to Use
16+
17+
<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
18+
19+
## Main Types
20+
21+
<!-- The main types provided in this library -->
22+
23+
The main types provided by this library are:
24+
25+
* ``
26+
* ``
27+
* ``
28+
29+
## Addtional Documentation
30+
31+
<!-- Links to further documentation. Remove conceptual documentation if not available for the library. -->
32+
33+
* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview)
34+
* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**)
35+
36+
## Related Packages
37+
38+
<!-- The related packages associated with this package -->
39+
40+
## Feedback & Contributing
41+
42+
<!-- How to provide feedback on this package and contribute to it -->
43+
44+
Microsoft.Bcl.TimeProvider 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).

‎src/libraries/Microsoft.Extensions.Caching.Abstractions/src/PACKAGE.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## About
2+
3+
<!-- A description of the package and where one can find more documentation -->
4+
5+
6+
7+
## Key Features
8+
9+
<!-- The key features of this package -->
10+
11+
*
12+
*
13+
*
14+
15+
## How to Use
16+
17+
<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
18+
19+
## Main Types
20+
21+
<!-- The main types provided in this library -->
22+
23+
The main types provided by this library are:
24+
25+
* ``
26+
* ``
27+
* ``
28+
29+
## Addtional Documentation
30+
31+
<!-- Links to further documentation. Remove conceptual documentation if not available for the library. -->
32+
33+
* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview)
34+
* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**)
35+
36+
## Related Packages
37+
38+
<!-- The related packages associated with this package -->
39+
40+
## Feedback & Contributing
41+
42+
<!-- How to provide feedback on this package and contribute to it -->
43+
44+
Microsoft.Extensions.Caching.Abstractions 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).

‎src/libraries/Microsoft.Extensions.Caching.Memory/src/PACKAGE.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## About
2+
3+
<!-- A description of the package and where one can find more documentation -->
4+
5+
6+
7+
## Key Features
8+
9+
<!-- The key features of this package -->
10+
11+
*
12+
*
13+
*
14+
15+
## How to Use
16+
17+
<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
18+
19+
## Main Types
20+
21+
<!-- The main types provided in this library -->
22+
23+
The main types provided by this library are:
24+
25+
* ``
26+
* ``
27+
* ``
28+
29+
## Addtional Documentation
30+
31+
<!-- Links to further documentation. Remove conceptual documentation if not available for the library. -->
32+
33+
* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview)
34+
* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**)
35+
36+
## Related Packages
37+
38+
<!-- The related packages associated with this package -->
39+
40+
## Feedback & Contributing
41+
42+
<!-- How to provide feedback on this package and contribute to it -->
43+
44+
Microsoft.Extensions.Caching.Memory 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).

‎src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/PACKAGE.md‎

Lines changed: 39 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
11
## About
22

3+
<!-- A description of the package and where one can find more documentation -->
4+
35
Provides abstractions of key-value pair based configuration. Interfaces defined in this package are implemented by classes in [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/) and other configuration packages.
46

5-
Commonly used types:
7+
## Key Features
8+
9+
<!-- The key features of this package -->
610

7-
- [Microsoft.Extensions.Configuration.IConfiguration](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.iconfiguration)
8-
- [Microsoft.Extensions.Configuration.IConfigurationBuilder](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.iconfigurationbuilder)
9-
- [Microsoft.Extensions.Configuration.IConfigurationProvider](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.iconfigurationprovider)
10-
- [Microsoft.Extensions.Configuration.IConfigurationRoot](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.iconfigurationroot)
11-
- [Microsoft.Extensions.Configuration.IConfigurationSection](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.iconfigurationsection)
11+
*
12+
*
13+
*
1214

13-
For more information, see the documentation: [Configuration in .NET](https://learn.microsoft.com/dotnet/core/extensions/configuration).
15+
## How to Use
1416

15-
## Example
17+
<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
1618

1719
The example below shows a small code sample using this library and trying out the `ConfigurationKeyName` attribute available since .NET 6:
1820

@@ -39,3 +41,32 @@ var config = new ConfigurationBuilder()
3941
var options = config.Get<MyClass>();
4042
Console.WriteLine(options.NamedProperty); // returns "value for named property"
4143
```
44+
45+
## Main Types
46+
47+
<!-- The main types provided in this library -->
48+
49+
The main types provided by this library are:
50+
51+
* [`Microsoft.Extensions.Configuration.IConfiguration`](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.iconfiguration)
52+
* [`Microsoft.Extensions.Configuration.IConfigurationBuilder`](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.iconfigurationbuilder)
53+
* [`Microsoft.Extensions.Configuration.IConfigurationProvider`](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.iconfigurationprovider)
54+
* [`Microsoft.Extensions.Configuration.IConfigurationRoot`](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.iconfigurationroot)
55+
* [`Microsoft.Extensions.Configuration.IConfigurationSection`](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.iconfigurationsection)
56+
57+
## Addtional Documentation
58+
59+
<!-- Links to further documentation -->
60+
61+
* [Configuration in .NET](https://learn.microsoft.com/dotnet/core/extensions/configuration)
62+
* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/microsoft.extensions.configuration)
63+
64+
## Related Packages
65+
66+
<!-- The related packages associated with this package -->
67+
68+
## Feedback & Contributing
69+
70+
<!-- How to provide feedback on this package and contribute to it -->
71+
72+
Microsoft.Extensions.Configuration.Abstractions 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).

‎src/libraries/Microsoft.Extensions.Configuration.Binder/src/PACKAGE.md‎

Lines changed: 40 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,21 @@
11
## About
22

3+
<!-- A description of the package and where one can find more documentation -->
4+
35
Provides the functionality to bind an object to data in configuration providers for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). This package enables you to represent the configuration data as strongly-typed classes defined in the application code. To bind a configuration, use the [Microsoft.Extensions.Configuration.ConfigurationBinder.Get](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.configurationbinder.get) extension method on the `IConfiguration` object. To use this package, you also need to install a package for the [configuration provider](https://learn.microsoft.com/dotnet/core/extensions/configuration#configuration-providers), for example, [Microsoft.Extensions.Configuration.Json](https://www.nuget.org/packages/Microsoft.Extensions.Configuration.Json/) for the JSON provider.
46

5-
For more information, see the documentation: [Configuration in .NET](https://learn.microsoft.com/dotnet/core/extensions/configuration).
7+
## Key Features
8+
9+
<!-- The key features of this package -->
10+
11+
*
12+
*
13+
*
14+
15+
## How to Use
16+
17+
<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
618

7-
## Example
819
The following example shows how to bind a JSON configuration section to .NET objects.
920

1021
```cs
@@ -81,3 +92,30 @@ You can include a configuration file using a code like this in your `.csproj` fi
8192
</Content>
8293
</ItemGroup>
8394
```
95+
96+
## Main Types
97+
98+
<!-- The main types provided in this library -->
99+
100+
The main types provided by this library are:
101+
102+
* ``
103+
* ``
104+
* ``
105+
106+
## Addtional Documentation
107+
108+
<!-- Links to further documentation -->
109+
110+
* [Configuration in .NET](https://learn.microsoft.com/dotnet/core/extensions/configuration)
111+
* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/microsoft.extensions.configuration)
112+
113+
## Related Packages
114+
115+
<!-- The related packages associated with this package -->
116+
117+
## Feedback & Contributing
118+
119+
<!-- How to provide feedback on this package and contribute to it -->
120+
121+
Microsoft.Extensions.Configuration.Binder 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).

0 commit comments

Comments
 (0)