Skip to content
This repository was archived by the owner on Mar 26, 2025. It is now read-only.

Commit 1cbb007

Browse files
authored
Update README with badges (#3)
* Update README with github workflow and nuget badges
1 parent 4e436fe commit 1cbb007

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,34 @@
1-
# StoreLib ![.NET Core](https://github.com/TitleOS/StoreLib/workflows/.NET%20Core/badge.svg?branch=Public) [![HitCount](http://hits.dwyl.com/StoreDev/StoreLib.svg)](http://hits.dwyl.com/StoreDev/StoreLib)
2-
Storelib is a DotNet library that provides APIs to interact with the various Microsoft Store endpoints.
1+
# StoreLib
32

3+
[![GitHub stars](https://img.shields.io/github/stars/StoreDev/StoreLib?style=social)](https://github.com/StoreDev/StoreLib)
4+
[![GitHub Workflow - Build](https://img.shields.io/github/workflow/status/StoreDev/StoreLib/build?label=build)](https://github.com/StoreDev/StoreLib/actions?query=workflow%3Abuild)
5+
[![Nuget downloads](https://img.shields.io/nuget/dt/StoreLib)](https://www.nuget.org/packages/StoreLib)
6+
[![Nuget version](https://img.shields.io/nuget/v/StoreLib)](https://www.nuget.org/packages/StoreLib)
47

8+
Storelib is a DotNet library that provides APIs to interact with the various Microsoft Store endpoints.
59

6-
## Usage:
10+
## Usage
711

812
First, you must initialize the DisplayCatalogHandler with the settings of your choice. During which, the handler can be set to use any market, locale, or endpoint.
13+
914
```csharp
1015
DisplayCatalogHandler dcathandler = new DisplayCatalogHandler(DCatEndpoint.Production, new Locale(Market.US, Lang.en, true));
1116
```
17+
1218
The above snippet will create a handler that queries the production endpoint, specifiying the US/English market.
1319

1420
From there, the handler can query a product listing.
21+
1522
```csharp
1623
await dcathandler.QueryDCATAsync("9wzdncrfj3tj");
1724
```
1825

1926
Once you have a product queried, and ensure it was found using `dcathandler.IsFound`, then you can fetch all .appx, .eappx, .xvc and .msixvc packages respectively for the listing using `GetPackagesForProductAsync();`
2027

21-
### Example:
28+
### Example
29+
2230
Fetches and prints the FE3 download links for Netflix's app packages.
31+
2332
```csharp
2433
DisplayCatalogHandler dcathandler = DisplayCatalogHandler.ProductionConfig();
2534
await dcathandler.QueryDCATAsync("9wzdncrfj3tj");
@@ -29,9 +38,10 @@ foreach(Uri download in await dcathandler.GetPackagesForProductAsync())
2938
}
3039
```
3140

32-
### Tips:
41+
### Tips
3342

3443
The DisplayCatalogHandler also supports querying with an auth token. (The Store supports both the MSA format and the XBL3.0 token format) This allows you to query products in other Xbox Live Sandboxes and query flighted listings.
44+
3545
```csharp
3646
DisplayCatalogHandler dcathandler = DisplayCatalogHandler.ProductionConfig();
3747
await dcathandler.QueryDCATAsync("9wzdncrfj3tj", "AuthToken");

0 commit comments

Comments
 (0)