Improve package descriptions and release notes.

Remora · Oct 17, 2020 · 4de0d06 · 4de0d06
1 parent 6c3e98d
commit 4de0d06
Show file tree

Hide file tree

Showing 8 changed files with 76 additions and 10 deletions.
diff --git a/Backend/Remora.Discord.API.Abstractions/Remora.Discord.API.Abstractions.csproj b/Backend/Remora.Discord.API.Abstractions/Remora.Discord.API.Abstractions.csproj
@@ -5,7 +5,17 @@
     </PropertyGroup>
 
     <PropertyGroup>
-        <Version>1.0.0-beta2</Version>
+        <Version>1.0.0-beta3</Version>
+        <Description>
+            $(BaseDescription)
+
+            This package contains a complete set of type and API abstractions for the Discord API. It provides no
+            concrete implementations; rather, it acts as a general, library-agnostic standard definition of Discord's
+            API.
+        </Description>
+        <PackageReleaseNotes>
+            Implement better support for partial types.
+        </PackageReleaseNotes>
     </PropertyGroup>
 
     <ItemGroup>

diff --git a/Backend/Remora.Discord.API/Remora.Discord.API.csproj b/Backend/Remora.Discord.API/Remora.Discord.API.csproj
@@ -5,7 +5,16 @@
     </PropertyGroup>
 
     <PropertyGroup>
-        <Version>1.0.0-beta2</Version>
+        <Version>1.0.0-beta3</Version>
+        <Description>
+            $(BaseDescription)
+
+            This package contains the default implementations for the abstract API definitions, provided by
+            Remora.Discord.API.Abstractions.
+        </Description>
+        <PackageReleaseNotes>
+            Implement better support for partial types.
+        </PackageReleaseNotes>
     </PropertyGroup>
 
     <ItemGroup>

diff --git a/Backend/Remora.Discord.Gateway/Remora.Discord.Gateway.csproj b/Backend/Remora.Discord.Gateway/Remora.Discord.Gateway.csproj
@@ -5,7 +5,16 @@
     </PropertyGroup>
 
     <PropertyGroup>
-        <Version>1.0.0-beta2</Version>
+        <Version>1.0.0-beta3</Version>
+        <Description>
+            $(BaseDescription)
+
+            This package provides a fully-featured implementation of a Discord gateway client, complete with resume
+            capabilities and user-facing events.
+        </Description>
+        <PackageReleaseNotes>
+            Implement better support for partial types.
+        </PackageReleaseNotes>
     </PropertyGroup>
 
     <ItemGroup>

diff --git a/Backend/Remora.Discord.Rest/Remora.Discord.Rest.csproj b/Backend/Remora.Discord.Rest/Remora.Discord.Rest.csproj
@@ -5,7 +5,16 @@
     </PropertyGroup>
 
     <PropertyGroup>
-        <Version>1.0.0-beta2</Version>
+        <Version>1.0.0-beta3</Version>
+        <Description>
+            $(BaseDescription)
+
+            This package contains the default implementations of Discord's REST API, complete with client-side sanity
+            checks and rate limiting support.
+        </Description>
+        <PackageReleaseNotes>
+            Implement better support for partial types.
+        </PackageReleaseNotes>
     </PropertyGroup>
 
     <ItemGroup>

diff --git a/Backend/Remora.Discord.Unstable/Remora.Discord.Unstable.csproj b/Backend/Remora.Discord.Unstable/Remora.Discord.Unstable.csproj
@@ -6,12 +6,20 @@
     </PropertyGroup>
 
     <PropertyGroup>
-        <Version>1.0.0-beta1</Version>
+        <Version>1.0.0-beta2</Version>
         <Description>
-            Unstable features from the Discord API. This package should never be considered stable, and breaking
-            changes may be introduced in any release.
+            $(BaseDescription)
+
+            This package contains unstable features from the Discord API - that is, features that aren't in the official
+            documentation yet, but may be documented in a pull request or through community efforts.
+
+            The API in this package should never be considered stable, and breaking changes may be introduced in any
+            release. Once unstable features move into the official documentation, they will be transferred from this
+            component to the appropriate stable component of Remora.Discord.
         </Description>
-        <PackageReleaseNotes>Implement template API.</PackageReleaseNotes>
+        <PackageReleaseNotes>
+            Implement better support for partial types.
+        </PackageReleaseNotes>
     </PropertyGroup>
 
     <ItemGroup>

diff --git a/Backend/Remora.Discord/Remora.Discord.Core/Remora.Discord.Core.csproj b/Backend/Remora.Discord/Remora.Discord.Core/Remora.Discord.Core.csproj
@@ -5,7 +5,15 @@
     </PropertyGroup>
 
     <PropertyGroup>
-        <Version>1.0.0-beta2</Version>
+        <Version>1.0.0-beta3</Version>
+        <Description>
+            $(BaseDescription)
+
+            This package contains core supporting types for Remora.Discord, such as snowflakes and optionals.
+        </Description>
+        <PackageReleaseNotes>
+            Implement better support for partial types.
+        </PackageReleaseNotes>
     </PropertyGroup>
 
 </Project>
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -47,6 +47,10 @@
         <PackageOutputPath>$(SolutionDir)/nuget</PackageOutputPath>
         <PackageProjectUrl>https://github.com/Nihlus/Remora.Discord</PackageProjectUrl>
         <PackageTags>discord;bot;api;</PackageTags>
+
+        <BaseDescription>
+            Remora.Discord is a .NET library for the Discord API, built for performance, reliability, and concurrency.
+        </BaseDescription>
     </PropertyGroup>
 
     <!-- Code inspection properties -->

diff --git a/Remora.Discord/Remora.Discord.csproj b/Remora.Discord/Remora.Discord.csproj
@@ -5,7 +5,16 @@
     </PropertyGroup>
 
     <PropertyGroup>
-        <Version>1.0.0-beta2</Version>
+        <Version>1.0.0-beta3</Version>
+        <Description>
+            $(BaseDescription)
+
+            This package is a metapackage for Remora.Discord, providing references to everything you need to get
+            started.
+        </Description>
+        <PackageReleaseNotes>
+            Implement better support for partial types.
+        </PackageReleaseNotes>
     </PropertyGroup>
 
     <ItemGroup>