You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by ta...@apache.org on 2022/06/29 17:43:39 UTC

[qpid-proton-dotnet] branch main updated: PROTON-2551 Add a README.md to the engine and client nuget package

This is an automated email from the ASF dual-hosted git repository.

tabish pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/qpid-proton-dotnet.git


The following commit(s) were added to refs/heads/main by this push:
     new cc46e40  PROTON-2551 Add a README.md to the engine and client nuget package
cc46e40 is described below

commit cc46e408aba5d79f704eade4f10ebf6c0dcfa0b4
Author: Timothy Bish <ta...@gmail.com>
AuthorDate: Wed Jun 29 13:42:29 2022 -0400

    PROTON-2551 Add a README.md to the engine and client nuget package
    
    Provides a readme for the nuget packages which can be used to convery
    information about the project when uploaded to nuget after a release.
---
 common.props                | 2 ++
 src/Proton.Client/README.md | 8 ++++++++
 src/Proton/README.md        | 9 +++++++++
 3 files changed, 19 insertions(+)

diff --git a/common.props b/common.props
index 3ead60e..71cd081 100644
--- a/common.props
+++ b/common.props
@@ -55,6 +55,7 @@
     <Copyright>Copyright © 2022 The Apache Software Foundation.</Copyright>
     <PackageIcon>qpid.png</PackageIcon>
     <PackageLicenseFile>LICENSE</PackageLicenseFile>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
     <PackageProjectUrl>https://qpid.apache.org/</PackageProjectUrl>
     <PackageTags>Qpid;Apache;AMQP;Messaging;Protocol</PackageTags>
     <RepositoryUrl Condition="'$(RepositoryUrl)' == ''">https://github.com/apache/qpid-proton-dotnet.git</RepositoryUrl>
@@ -64,6 +65,7 @@
     <None Include="$(MSBuildThisFileDirectory)\LICENSE" Pack="true" Visible="false" PackagePath=""/>
     <None Include="$(MSBuildThisFileDirectory)\NOTICE" Pack="true" Visible="false" PackagePath=""/>
     <None Include="$(MSBuildThisFileDirectory)\qpid.png" Pack="true" Visible="false" PackagePath=""/>
+    <None Include="README.md" Pack="true" PackagePath="\"/>
   </ItemGroup>
 
   <PropertyGroup>
diff --git a/src/Proton.Client/README.md b/src/Proton.Client/README.md
new file mode 100644
index 0000000..9c8c994
--- /dev/null
+++ b/src/Proton.Client/README.md
@@ -0,0 +1,8 @@
+# Apache Qpid Proton DotNet Client
+==================================
+
+Qpid Proton DotNet is a high-performance, lightweight AMQP Client that provides an
+imperative API whic can be used in the widest range of messaging applications.
+
+Please see http://qpid.apache.org/proton for more information.
+
diff --git a/src/Proton/README.md b/src/Proton/README.md
new file mode 100644
index 0000000..e9c8043
--- /dev/null
+++ b/src/Proton/README.md
@@ -0,0 +1,9 @@
+# Apache Qpid Proton DotNet
+===========================
+
+Qpid Proton DotNet is a high-performance, lightweight AMQP protocol engine. 
+It can be used to create AMQP 1.0 nessaging clients and servers or in tooling
+that requires a fast AMQP 1.0 protocol codec.
+
+Please see http://qpid.apache.org/proton for more information.
+


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org