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

Adding Readme file for each Nuget package #5682

Merged
merged 6 commits into from
Nov 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions Directory.Build.targets
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,10 @@
<_Parameter1>true</_Parameter1>
</AssemblyAttribute>
</ItemGroup>

<ItemGroup Condition="Exists('README.md')" >
<None Include="README.md" Pack="true" PackagePath="\"/>
</ItemGroup>

<Import Project="eng\RuntimePackages.targets" Condition="'$(StrongNameKeyId)' == 'Microsoft'" />
</Project>
18 changes: 18 additions & 0 deletions src/System.ServiceModel.Federation/src/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
## About

The System.ServiceModel.Federation provides the types that allow security communications with SOAP messages using WS-Federation.

### Installing the package:

Install System.ServiceModel.Federation package from [Nuget.org](https://www.nuget.org/packages/System.ServiceModel.Federation)

`dotnet add package System.ServiceModel.Federation`

## How to use

See [blog post](https://devblogs.microsoft.com/dotnet/wsfederationhttpbinding-in-net-standard-wcf/) for more information.

## Feedback & Contributing

To explore the project or contribute, visit our [GitHub repository](https://github.com/dotnet/wcf/).
For reporting issues or providing feedback, please [open an issue on GitHub](https://github.com/dotnet/wcf).
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
<!-- Enable transitive pinning due to Microsoft.IdentityModel.Protocols.WsTrust not being
proactively updated by the identity team and it now references vulnerable dependencies -->
<CentralPackageTransitivePinningEnabled>true</CentralPackageTransitivePinningEnabled>
<PackageDescription>Provides the types that allow security communications with SOAP messages using WS-Federation.</PackageDescription>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<PackageReadmeFile>README.md</PackageReadmeFile>
</PropertyGroup>
<ItemGroup>
<ProjectReference Include="..\..\System.ServiceModel.Primitives\src\System.ServiceModel.Primitives.csproj" />
Expand Down
18 changes: 18 additions & 0 deletions src/System.ServiceModel.Http/src/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
## About

The System.ServiceModel.Http provides the types that permit SOAP messages to be exchanged using Http (example: BasicHttpBinding).

### Installing the package:

Install System.ServiceModel.Http package from [Nuget.org](https://www.nuget.org/packages/System.ServiceModel.Http)

`dotnet add package System.ServiceModel.Http`

## How to use

See [WCF Samples](https://learn.microsoft.com/en-us/dotnet/framework/wcf/samples/) for samples on how to use System.ServiceModel.Http.

## Feedback & Contributing

To explore the project or contribute, visit our [GitHub repository](https://github.com/dotnet/wcf/).
For reporting issues or providing feedback, please [open an issue on GitHub](https://github.com/dotnet/wcf).
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<NoWarn>$(NoWarn);NU5131</NoWarn>
<TargetFrameworks>$(DotNetVersion);$(NetFrameworkVersion);netstandard2.0</TargetFrameworks>
<IsShipping>$(Ship_WcfPackages)</IsShipping>
<PackageDescription>Provides the types that permit SOAP messages to be exchanged using Http (example: BasicHttpBinding).</PackageDescription>
<PackageReadmeFile>README.md</PackageReadmeFile>
</PropertyGroup>

<ItemGroup Condition="'$(TargetFramework)' != '$(NetFrameworkVersion)'">
Expand Down
18 changes: 18 additions & 0 deletions src/System.ServiceModel.NetFramingBase/src/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
## About

The System.ServiceModel.NetFramingBase contains common types for NetFraming based transports such as NetTcp and NetNamedPipe.

### Installing the package:

Install System.ServiceModel.NetFramingBase package from [Nuget.org](https://www.nuget.org/packages/System.ServiceModel.NetFramingBase)

`dotnet add package System.ServiceModel.NetFramingBase`

## How to use

See [WCF Samples](https://learn.microsoft.com/en-us/dotnet/framework/wcf/samples/) for samples on how to use NetTcp and NetNamedPipe.

## Feedback & Contributing

To explore the project or contribute, visit our [GitHub repository](https://github.com/dotnet/wcf/).
For reporting issues or providing feedback, please [open an issue on GitHub](https://github.com/dotnet/wcf).
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<IsShipping>$(Ship_WcfPackages)</IsShipping>
<TargetFrameworks>$(DotNetVersion)</TargetFrameworks>
<RootNamespace>System.ServiceModel</RootNamespace>
<PackageDescription>Contain common types for NetFraming based transports such as NetTcp and NetNamedPipe.</PackageDescription>
<PackageReadmeFile>README.md</PackageReadmeFile>
</PropertyGroup>

<ItemGroup>
Expand Down
18 changes: 18 additions & 0 deletions src/System.ServiceModel.NetNamedPipe/src/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
## About

The System.ServiceModel.NetNamedPipe provides the types that permit SOAP messages to be exchanged using TCP (example: NetTcpBinding).

### Installing the package:

Install System.ServiceModel.NetNamedPipe package from [Nuget.org](https://www.nuget.org/packages/System.ServiceModel.NetNamedPipe)

`dotnet add package System.ServiceModel.NetNamedPipe`

## How to use

See [WCF Samples](https://learn.microsoft.com/en-us/dotnet/framework/wcf/samples/) for samples on how to use NetNamePipe and NetTcpBinding.

## Feedback & Contributing

To explore the project or contribute, visit our [GitHub repository](https://github.com/dotnet/wcf/).
For reporting issues or providing feedback, please [open an issue on GitHub](https://github.com/dotnet/wcf).
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<TargetFrameworks>$(DotNetVersion)</TargetFrameworks>
<RootNamespace>System.ServiceModel</RootNamespace>
<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
<PackageDescription>Provides the types that permit SOAP messages to be exchanged using named pipes (example: NetNamedPipeBinding).</PackageDescription>
<PackageReadmeFile>README.md</PackageReadmeFile>
</PropertyGroup>

<ItemGroup>
Expand Down
18 changes: 18 additions & 0 deletions src/System.ServiceModel.NetTcp/src/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
## About

The System.ServiceModel.NetTcp provides the types that permit SOAP messages to be exchanged using TCP (example: NetTcpBinding).

### Installing the package:

Install System.ServiceModel.NetTcp package from [Nuget.org](https://www.nuget.org/packages/System.ServiceModel.NetTcp)

`dotnet add package System.ServiceModel.NetTcp`

## How to use

See [WCF Samples](https://learn.microsoft.com/en-us/dotnet/framework/wcf/samples/) for samples on how to use NetTcp.

## Feedback & Contributing

To explore the project or contribute, visit our [GitHub repository](https://github.com/dotnet/wcf/).
For reporting issues or providing feedback, please [open an issue on GitHub](https://github.com/dotnet/wcf).
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<NoWarn>$(NoWarn);NU5131</NoWarn>
<TargetFrameworks>$(DotNetVersion);$(NetFrameworkVersion);netstandard2.0</TargetFrameworks>
<IsShipping>$(Ship_WcfPackages)</IsShipping>
<PackageDescription>Provides the types that permit SOAP messages to be exchanged using TCP (example: NetTcpBinding).</PackageDescription>
<PackageReadmeFile>README.md</PackageReadmeFile>
</PropertyGroup>

<ItemGroup Condition="'$(TargetFramework)' != '$(NetFrameworkVersion)'">
Expand Down
18 changes: 18 additions & 0 deletions src/System.ServiceModel.Primitives/src/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
## About

The System.ServiceModel.Primitives provides the common types used by all of the WCF libraries.

### Installing the package:

Install System.ServiceModel.Primitives package from [Nuget.org](https://www.nuget.org/packages/System.ServiceModel.Primitives)

`dotnet add package System.ServiceModel.Primitives`

## How to use

Explore [WCF Samples](https://learn.microsoft.com/en-us/dotnet/framework/wcf/samples/) for more WCF samples.

## Feedback & Contributing

To explore the project or contribute, visit our [GitHub repository](https://github.com/dotnet/wcf/).
For reporting issues or providing feedback, please [open an issue on GitHub](https://github.com/dotnet/wcf).
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@
<TargetFrameworks>$(DotNetVersion);$(NetFrameworkVersion);netstandard2.0</TargetFrameworks>
<LangVersion>latest</LangVersion>
<IsShipping>$(Ship_WcfPackages)</IsShipping>
<PackageDescription>Provides the common types used by all of the WCF libraries.</PackageDescription>
<!-- The implementation assembly for Primitives doesn't yet match the reference assembly
Generating the reference assembly would generate api's we don't want. For now the
Primitives.Ref project has disabled EnableDefaultCompileItems so if it was generated,
we wouldn't compile it anyway. -->
<GenAPIGenerateReferenceAssemblySource>false</GenAPIGenerateReferenceAssemblySource>
<IncludeSRCommonCode>false</IncludeSRCommonCode>
<PackageReadmeFile>README.md</PackageReadmeFile>
</PropertyGroup>
<ItemGroup Condition="'$(TargetFramework)' == '$(DotNetVersion)'">
<InternalsVisibleTo Include="System.ServiceModel.Http" />
Expand Down
18 changes: 18 additions & 0 deletions src/System.ServiceModel.UnixDomainSocket/src/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
## About

The System.ServiceModel.UnixDomainSocket Provides the types that allow security communications with SOAP messages using WS-Federation.

### Installing the package:

Install System.ServiceModel.UnixDomainSocket package from [Nuget.org](https://www.nuget.org/packages/System.ServiceModel.UnixDomainSocket)

`dotnet add package System.ServiceModel.UnixDomainSocket`

## How to use

See [blog post](https://corewcf.github.io/blog/2023/09/01/udsbinding) for more information.

## Feedback & Contributing

To explore the project or contribute, visit our [GitHub repository](https://github.com/dotnet/wcf/).
For reporting issues or providing feedback, please [open an issue on GitHub](https://github.com/dotnet/wcf).
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
<TargetFrameworks>$(DotNetVersion)</TargetFrameworks>
<IsShipping>$(Ship_WcfPackages)</IsShipping>
<PackageDescription>Provides the types that permit SOAP messages to be exchanged using Unix domain socket.</PackageDescription>
<PackageReadmeFile>README.md</PackageReadmeFile>
</PropertyGroup>

<ItemGroup>
Expand Down
18 changes: 18 additions & 0 deletions src/System.Web.Services.Description/src/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
## About

The System.Web.Services.Description contains classes that enable you to publicly describe an XML Web service by using the Web Services Description Language (WSDL).

### Installing the package:

Install System.Web.Services.Description package from [Nuget.org](https://www.nuget.org/packages/System.Web.Services.Description)

`dotnet add package System.Web.Services.Description`

## How to use

Explore [WCF Samples](https://learn.microsoft.com/en-us/dotnet/framework/wcf/samples/) for more WCF samples.

## Feedback & Contributing

To explore the project or contribute, visit our [GitHub repository](https://github.com/dotnet/wcf/).
For reporting issues or providing feedback, please [open an issue on GitHub](https://github.com/dotnet/wcf).
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<TargetFrameworks>netstandard2.0;$(NetFrameworkVersion)</TargetFrameworks>
<IsPartialFacadeAssembly Condition="'$(TargetFramework)' == '$(NetFrameworkVersion)'">true</IsPartialFacadeAssembly>
<EnableDefaultItems Condition="'$(TargetFramework)' == '$(NetFrameworkVersion)'">false</EnableDefaultItems>
<PackageDescription>Contains classes that enable you to publicly describe an XML Web service by using the Web Services Description Language (WSDL).</PackageDescription>
<PackageReadmeFile>README.md</PackageReadmeFile>
</PropertyGroup>

<ItemGroup Condition="'$(TargetFramework)' == '$(NetFrameworkVersion)'">
Expand Down
Loading