Skip to content

Commit 89d0e65

Browse files
committed
Merge branch 'main' into implementation/eventstreamhandlers/virtual/images
2 parents 7421341 + f7af157 commit 89d0e65

6 files changed

Lines changed: 50 additions & 52 deletions

File tree

.idea/.idea.WindowsAppCommunity.Sdk/.idea/.gitignore

Lines changed: 0 additions & 13 deletions
This file was deleted.

.idea/.idea.WindowsAppCommunity.Sdk/.idea/encodings.xml

Lines changed: 0 additions & 4 deletions
This file was deleted.

.idea/.idea.WindowsAppCommunity.Sdk/.idea/indexLayout.xml

Lines changed: 0 additions & 8 deletions
This file was deleted.

.idea/.idea.WindowsAppCommunity.Sdk/.idea/vcs.xml

Lines changed: 0 additions & 6 deletions
This file was deleted.

README.md

Lines changed: 42 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,58 @@
1-
# WindowsAppCommunity.Sdk [![Version](https://img.shields.io/nuget/v/WindowsAppCommunity.Sdk.svg)](https://www.nuget.org/packages/WindowsAppCommunity.Sdk)
1+
> [!WARNING]
2+
> This is a **work in progress** and is not yet ready for use. Please check back later.
23
3-
Manage your user, projects and publisher membership in the Windows App Community. Fully peer-to-peer.
4-
![Banner2](https://github.com/user-attachments/assets/9fbe1f09-cf9d-406f-8df5-58d069ef7a00)
4+
<p align="center">
5+
<img alt="Hero Image" src="https://github.com/user-attachments/assets/ac6d3215-1633-4f09-af31-4203176e904d" />
6+
</p>
57

6-
This is a Work In Progress and is not yet ready for use. Please check back later.
8+
<p align="center">
9+
<a style="text-decoration:none" href="https://windowsappcommunity.com/">
10+
<img src="https://img.shields.io/badge/Community-Website-teal" alt="WindowsAppCommunity Website" /></a>
11+
<a style="text-decoration:none" href="https://www.nuget.org/packages/WindowsAppCommunity.Sdk">
12+
<img src="https://img.shields.io/nuget/v/WindowsAppCommunity.Sdk.svg" alt="Version" /></a>
13+
<a style="text-decoration:none" href="https://dsc.gg/uwpc">
14+
<img src="https://img.shields.io/discord/372137812037730304?label=Discord&color=7289da" alt="WinAppCommunity Discord" /></a>
15+
</p>
716

8-
Intended to supersede https://github.com/WindowsAppCommunity/uwpcommunity-backend
17+
Introducing the **Windows App Community SDK**, a library that enables you to manage your membership, projects and publisher data in the Windows App Community.
18+
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.
19+
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.
920

10-
## Featuring:
11-
- x
12-
- y
13-
- z
21+
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]
1422

15-
## Install
23+
<!--
24+
## Features
1625
17-
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).
26+
- **x**:
27+
- **y**:
28+
- **z**:
29+
-->
1830

19-
PM> Install-Package WindowsAppCommunity.Sdk
20-
21-
Or using [dotnet](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet)
31+
## Usage
2232

23-
> dotnet add package WindowsAppCommunity.Sdk
33+
### Installing the SDK
2434

25-
## Usage
35+
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):
36+
```ps1
37+
PM> Install-Package WindowsAppCommunity.Sdk
38+
```
39+
Or using the [dotnet](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet) CLI
2640

27-
```cs
28-
// TODO
41+
```ps1
42+
> dotnet add package WindowsAppCommunity.Sdk
2943
```
3044

31-
## Versioning
45+
> [!NOTE]
46+
> Version numbering follows the Semantic versioning approach.
3247
33-
Version numbering follows the Semantic versioning approach.
48+
### Usage
49+
50+
```cs
51+
// TODO
52+
```
3453

3554
## License
3655

37-
This code is licensed under the MIT License. See the [LICENSE](LICENSE.md) file for more details.
56+
Copyright (c) 2022 - present Arlo Godfrey
57+
58+
Licensed under the [MIT LICENSE](./src/LICENSE.txt).

src/WindowsAppCommunity.Sdk.csproj

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ Initial release of WindowsAppCommunity.Sdk.
2727
<DebugType>embedded</DebugType>
2828
<NeutralLanguage>en</NeutralLanguage>
2929
<Authors>Arlo Godfrey</Authors>
30+
<PackageReadmeFile>README.md</PackageReadmeFile>
3031
<PackageLicenseExpression>MIT</PackageLicenseExpression>
3132
</PropertyGroup>
3233

@@ -46,6 +47,13 @@ Initial release of WindowsAppCommunity.Sdk.
4647
<Deterministic>true</Deterministic>
4748
</PropertyGroup>
4849

50+
<ItemGroup>
51+
<None Include="..\README.md">
52+
<Pack>True</Pack>
53+
<PackagePath>\</PackagePath>
54+
</None>
55+
</ItemGroup>
56+
4957
<ItemGroup>
5058
<PackageReference Include="Microsoft.Bcl.AsyncInterfaces" Version="9.0.0" />
5159
<PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="All" />

0 commit comments

Comments
 (0)