chore: add readme files to all nuget packages

thinktecture · Jul 15, 2024 · c528d7c · c528d7c
1 parent 1c3fb15
commit c528d7c
Show file tree

Hide file tree

Showing 26 changed files with 91 additions and 0 deletions.
diff --git a/src/Thinktecture.Relay.Abstractions/README.md b/src/Thinktecture.Relay.Abstractions/README.md
@@ -0,0 +1,3 @@
+# Thinktecture.Relay.Abstractions
+
+Contains abstractions for the RelayServer 3.
diff --git a/src/Thinktecture.Relay.Abstractions/Thinktecture.Relay.Abstractions.csproj b/src/Thinktecture.Relay.Abstractions/Thinktecture.Relay.Abstractions.csproj
@@ -11,6 +11,10 @@
     <RootNamespace>Thinktecture.Relay</RootNamespace>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="/" />
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="System.Text.Json" Version="8.0.4" />
   </ItemGroup>

diff --git a/src/Thinktecture.Relay.Connector.Abstractions/README.md b/src/Thinktecture.Relay.Connector.Abstractions/README.md
@@ -0,0 +1,3 @@
+# Thinktecture.Relay.Connector.Abstractions
+
+Contains interfaces and base classes for a RelayServer 3 Connector.
diff --git a/...hinktecture.Relay.Connector.Abstractions/Thinktecture.Relay.Connector.Abstractions.csproj b/...hinktecture.Relay.Connector.Abstractions/Thinktecture.Relay.Connector.Abstractions.csproj
@@ -7,6 +7,10 @@
     <RootNamespace>Thinktecture.Relay.Connector</RootNamespace>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="/" />
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="8.0.1" />
     <PackageReference Include="Microsoft.Extensions.Options" Version="8.0.2" />

diff --git a/src/Thinktecture.Relay.Connector.Protocols.SignalR/README.md b/src/Thinktecture.Relay.Connector.Protocols.SignalR/README.md
@@ -0,0 +1,3 @@
+# Thinktecture.Relay.Connector.Protocols.SignalR
+
+Contains the SignalR transport implementation used by the RelayServer 3 Connector to connect to the RelayServer.
diff --git a/...e.Relay.Connector.Protocols.SignalR/Thinktecture.Relay.Connector.Protocols.SignalR.csproj b/...e.Relay.Connector.Protocols.SignalR/Thinktecture.Relay.Connector.Protocols.SignalR.csproj
@@ -6,6 +6,10 @@
     <Description>Contains the SignalR connector transport implementation for the RelayServer.</Description>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="/" />
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="Microsoft.AspNetCore.SignalR.Client" Version="8.0.4" />
   </ItemGroup>

diff --git a/src/Thinktecture.Relay.Connector/README.md b/src/Thinktecture.Relay.Connector/README.md
@@ -0,0 +1,3 @@
+# Thinktecture.Relay.Connector
+
+Contains the implementation to include a RelayServer 3 Connector into your projects.
diff --git a/src/Thinktecture.Relay.Connector/Thinktecture.Relay.Connector.csproj b/src/Thinktecture.Relay.Connector/Thinktecture.Relay.Connector.csproj
@@ -6,6 +6,10 @@
     <Description>Contains the connector implementations for the RelayServer.</Description>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="/" />
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="IdentityModel.AspNetCore" Version="4.3.0" />
   </ItemGroup>

diff --git a/src/Thinktecture.Relay.Server.Abstractions/README.md b/src/Thinktecture.Relay.Server.Abstractions/README.md
@@ -0,0 +1,3 @@
+# Thinktecture.Relay.Server.Abstractions
+
+Contains interfaces and base classes for the server implementation of RelayServer 3.
diff --git a/src/Thinktecture.Relay.Server.Abstractions/Thinktecture.Relay.Server.Abstractions.csproj b/src/Thinktecture.Relay.Server.Abstractions/Thinktecture.Relay.Server.Abstractions.csproj
@@ -7,6 +7,10 @@
     <RootNamespace>Thinktecture.Relay.Server</RootNamespace>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="/" />
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="Microsoft.AspNetCore.Http.Abstractions" Version="2.2.0" />
     <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="8.0.1" />

diff --git a/src/Thinktecture.Relay.Server.Interceptors/README.md b/src/Thinktecture.Relay.Server.Interceptors/README.md
@@ -0,0 +1,3 @@
+# Thinktecture.Relay.Server.Interceptors
+
+Contains optional interceptor implementations for the RelayServer 3.
diff --git a/src/Thinktecture.Relay.Server.Interceptors/Thinktecture.Relay.Server.Interceptors.csproj b/src/Thinktecture.Relay.Server.Interceptors/Thinktecture.Relay.Server.Interceptors.csproj
@@ -7,6 +7,10 @@
     <RootNamespace>Thinktecture.Relay.Server.Interceptors</RootNamespace>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="/" />
+  </ItemGroup>
+
   <ItemGroup>
     <ProjectReference Include="..\Thinktecture.Relay.Server.Abstractions\Thinktecture.Relay.Server.Abstractions.csproj" />
   </ItemGroup>

diff --git a/src/Thinktecture.Relay.Server.Management/README.md b/src/Thinktecture.Relay.Server.Management/README.md
@@ -0,0 +1,3 @@
+# Thinktecture.Relay.Server.Management
+
+Contains endpoints for an optional RelayServer 3 management API.
diff --git a/src/Thinktecture.Relay.Server.Management/Thinktecture.Relay.Server.Management.csproj b/src/Thinktecture.Relay.Server.Management/Thinktecture.Relay.Server.Management.csproj
@@ -7,6 +7,10 @@
     <RootNamespace>Thinktecture.Relay.Server.Management</RootNamespace>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="/" />
+  </ItemGroup>
+
   <ItemGroup>
     <FrameworkReference Include="Microsoft.AspNetCore.App" />
   </ItemGroup>

diff --git a/src/Thinktecture.Relay.Server.Persistence.EntityFrameworkCore.PostgreSql/README.md b/src/Thinktecture.Relay.Server.Persistence.EntityFrameworkCore.PostgreSql/README.md
@@ -0,0 +1,3 @@
+# Thinktecture.Relay.Server.Persistence.EntityFrameworkCore.PostgreSql
+
+Contains the PostgreSQL specific migrations for the RelayServer 3 EF Core persistence.
diff --git a/...re.PostgreSql/Thinktecture.Relay.Server.Persistence.EntityFrameworkCore.PostgreSql.csproj b/...re.PostgreSql/Thinktecture.Relay.Server.Persistence.EntityFrameworkCore.PostgreSql.csproj
@@ -7,6 +7,10 @@
     <NoWarn>CS1591</NoWarn>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="/" />
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="8.0.2" />
   </ItemGroup>

diff --git a/src/Thinktecture.Relay.Server.Persistence.EntityFrameworkCore.SqlServer/README.md b/src/Thinktecture.Relay.Server.Persistence.EntityFrameworkCore.SqlServer/README.md
@@ -0,0 +1,3 @@
+# Thinktecture.Relay.Server.Persistence.EntityFrameworkCore.SqlServer
+
+Contains the SQL Server specific migrations for the RelayServer 3 EF Core persistence.
diff --git a/...Core.SqlServer/Thinktecture.Relay.Server.Persistence.EntityFrameworkCore.SqlServer.csproj b/...Core.SqlServer/Thinktecture.Relay.Server.Persistence.EntityFrameworkCore.SqlServer.csproj
@@ -7,6 +7,10 @@
     <NoWarn>CS1591</NoWarn>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="/" />
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="8.0.4" />
   </ItemGroup>

diff --git a/src/Thinktecture.Relay.Server.Persistence.EntityFrameworkCore/README.md b/src/Thinktecture.Relay.Server.Persistence.EntityFrameworkCore/README.md
@@ -0,0 +1,3 @@
+# Thinktecture.Relay.Server.Persistence.EntityFrameworkCore
+
+Contains the EF Core context and entities for persisting RelayServer 3 information in a relational database.
diff --git a/...ence.EntityFrameworkCore/Thinktecture.Relay.Server.Persistence.EntityFrameworkCore.csproj b/...ence.EntityFrameworkCore/Thinktecture.Relay.Server.Persistence.EntityFrameworkCore.csproj
@@ -6,6 +6,10 @@
     <Description>Contains the EF Core context for data persistence.</Description>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="/" />
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="Microsoft.EntityFrameworkCore" Version="8.0.4" />
     <PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore" Version="8.0.4" />

diff --git a/src/Thinktecture.Relay.Server.Protocols.RabbitMq/README.md b/src/Thinktecture.Relay.Server.Protocols.RabbitMq/README.md
@@ -0,0 +1,3 @@
+# Thinktecture.Relay.Server.Protocols.RabbitMq
+
+Contains the RabbitMQ specific implementation of the server to server transport in RelayServer 3.
diff --git a/...cture.Relay.Server.Protocols.RabbitMq/Thinktecture.Relay.Server.Protocols.RabbitMq.csproj b/...cture.Relay.Server.Protocols.RabbitMq/Thinktecture.Relay.Server.Protocols.RabbitMq.csproj
@@ -6,6 +6,10 @@
     <Description>Contains the RabbitMQ server transport implementation for the RelayServer.</Description>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="/" />
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="8.0.0" />
     <PackageReference Include="Microsoft.Extensions.Options" Version="8.0.2" />

diff --git a/src/Thinktecture.Relay.Server.Protocols.SignalR/README.md b/src/Thinktecture.Relay.Server.Protocols.SignalR/README.md
@@ -0,0 +1,3 @@
+# Thinktecture.Relay.Server.Protocols.SignalR
+
+Contains the SignalR hub implementation in the server part of RelayServer 3.
diff --git a/...tecture.Relay.Server.Protocols.SignalR/Thinktecture.Relay.Server.Protocols.SignalR.csproj b/...tecture.Relay.Server.Protocols.SignalR/Thinktecture.Relay.Server.Protocols.SignalR.csproj
@@ -6,6 +6,10 @@
     <Description>Contains the SignalR server transport implementation for the RelayServer.</Description>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="/" />
+  </ItemGroup>
+
   <ItemGroup>
     <FrameworkReference Include="Microsoft.AspNetCore.App" />
   </ItemGroup>

diff --git a/src/Thinktecture.Relay.Server/README.md b/src/Thinktecture.Relay.Server/README.md
@@ -0,0 +1,3 @@
+# Thinktecture.Relay.Server
+
+Contains the server implementation of RelayServer 3.
diff --git a/src/Thinktecture.Relay.Server/Thinktecture.Relay.Server.csproj b/src/Thinktecture.Relay.Server/Thinktecture.Relay.Server.csproj
@@ -6,6 +6,10 @@
     <Description>Contains the server implementations for the RelayServer.</Description>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="/" />
+  </ItemGroup>
+
   <ItemGroup>
     <FrameworkReference Include="Microsoft.AspNetCore.App" />
   </ItemGroup>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Thinktecture.Relay.Abstractions

		Contains abstractions for the RelayServer 3.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Thinktecture.Relay.Connector.Abstractions

		Contains interfaces and base classes for a RelayServer 3 Connector.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Thinktecture.Relay.Connector.Protocols.SignalR

		Contains the SignalR transport implementation used by the RelayServer 3 Connector to connect to the RelayServer.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Thinktecture.Relay.Connector

		Contains the implementation to include a RelayServer 3 Connector into your projects.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Thinktecture.Relay.Server.Abstractions

		Contains interfaces and base classes for the server implementation of RelayServer 3.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Thinktecture.Relay.Server.Interceptors

		Contains optional interceptor implementations for the RelayServer 3.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Thinktecture.Relay.Server.Management

		Contains endpoints for an optional RelayServer 3 management API.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Thinktecture.Relay.Server.Persistence.EntityFrameworkCore.PostgreSql

		Contains the PostgreSQL specific migrations for the RelayServer 3 EF Core persistence.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Thinktecture.Relay.Server.Persistence.EntityFrameworkCore.SqlServer

		Contains the SQL Server specific migrations for the RelayServer 3 EF Core persistence.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Thinktecture.Relay.Server.Persistence.EntityFrameworkCore

		Contains the EF Core context and entities for persisting RelayServer 3 information in a relational database.