Merge pull request #8 from Lamparter/readme

GitHub: Improve `README.md`

Author: Arlodotexe

README.md

@@ -1,37 +1,58 @@
-# WindowsAppCommunity.Sdk [![Version](https://img.shields.io/nuget/v/WindowsAppCommunity.Sdk.svg)](https://www.nuget.org/packages/WindowsAppCommunity.Sdk)
+> [!WARNING]
+> This is a **work in progress** and is not yet ready for use. Please check back later.
 
-Manage your user, projects and publisher membership in the Windows App Community. Fully peer-to-peer.
-![Banner2](https://github.com/user-attachments/assets/9fbe1f09-cf9d-406f-8df5-58d069ef7a00)
+<p align="center">
+  <img alt="Hero Image" src="https://github.com/user-attachments/assets/ac6d3215-1633-4f09-af31-4203176e904d" />
+</p>
 
-This is a Work In Progress and is not yet ready for use. Please check back later.
+<p align="center">
+  <a style="text-decoration:none" href="https://windowsappcommunity.com/">
+    <img src="https://img.shields.io/badge/Community-Website-teal" alt="WindowsAppCommunity Website" /></a>
+  <a style="text-decoration:none" href="https://www.nuget.org/packages/WindowsAppCommunity.Sdk">
+    <img src="https://img.shields.io/nuget/v/WindowsAppCommunity.Sdk.svg" alt="Version" /></a>
+  <a style="text-decoration:none" href="https://dsc.gg/uwpc">
+    <img src="https://img.shields.io/discord/372137812037730304?label=Discord&color=7289da" alt="WinAppCommunity Discord" /></a>
+</p>
 
-Intended to supersede https://github.com/WindowsAppCommunity/uwpcommunity-backend
+Introducing the **Windows App Community SDK**, a library that enables you to manage your membership, projects and publisher data in the Windows App Community.
+The `WindowsAppCommunity.Sdk` library was created to supersede the original [`uwpcommunity-backend`](https://github.com/WindowsAppCommunity/uwpcommunity-backend) (known to many as **Server Companion**) that has served the community for over 5 years.
+The "new infra", as this library is often referred to by many members of the community, has been in the works for ages. We're pleased to announce that it's now in rapid development.
 
-## Featuring:
-- x
-- y
-- z
+Built using the content-addressing capabilities of [`ipfs`](https://ipfs.tech/), a powerful p2p protocol alternative to `http`, the new community infra boasts powerful features such as... [todo, come back soon]
 
-## Install
+<!--
+## Features
 
-Published releases are available on [NuGet](https://www.nuget.org/packages/WindowsAppCommunity.Sdk). To install, run the following command in the [Package Manager Console](https://docs.nuget.org/docs/start-here/using-the-package-manager-console).
+- **x**: 
+- **y**: 
+- **z**:
+-->
 
-    PM> Install-Package WindowsAppCommunity.Sdk
-    
-Or using [dotnet](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet)
+## Usage
 
-    > dotnet add package WindowsAppCommunity.Sdk
+### Installing the SDK
 
-## Usage
+Published releases are available on [NuGet](https://www.nuget.org/packages/WindowsAppCommunity.Sdk). To install, run the following command in the [Package Manager Console](https://docs.nuget.org/docs/start-here/using-the-package-manager-console):
+```ps1
+PM> Install-Package WindowsAppCommunity.Sdk
+``` 
+Or using the [dotnet](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet) CLI
 
-```cs
-// TODO
+```ps1
+> dotnet add package WindowsAppCommunity.Sdk
 ```
 
-## Versioning
+> [!NOTE]
+> Version numbering follows the Semantic versioning approach.
 
-Version numbering follows the Semantic versioning approach.
+### Usage
+
+```cs
+// TODO
+```
 
 ## License
 
-This code is licensed under the MIT License. See the [LICENSE](LICENSE.md) file for more details.
+Copyright (c) 2022 - present Arlo Godfrey
+
+Licensed under the [MIT LICENSE](./src/LICENSE.txt).

src/WindowsAppCommunity.Sdk.csproj

@@ -27,6 +27,7 @@ Initial release of WindowsAppCommunity.Sdk.
 		<DebugType>embedded</DebugType>
 		<NeutralLanguage>en</NeutralLanguage>
 		<Authors>Arlo Godfrey</Authors>
+		<PackageReadmeFile>README.md</PackageReadmeFile>
 		<PackageLicenseExpression>MIT</PackageLicenseExpression>
 	</PropertyGroup>
 
@@ -46,6 +47,13 @@ Initial release of WindowsAppCommunity.Sdk.
 		<Deterministic>true</Deterministic>
 	</PropertyGroup>
 
+	<ItemGroup>
+		<None Include="..\README.md">
+		  <Pack>True</Pack>
+		  <PackagePath>\</PackagePath>
+		</None>
+	</ItemGroup>
+
 	<ItemGroup>
 		<PackageReference Include="Microsoft.Bcl.AsyncInterfaces" Version="9.0.0" />
 		<PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="All" />