Serraniel/japanese-pokemon-cards-sdk-csharp
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
Daniel 2023-03-03 19:28:34 +01:00 committed by GitHub
parent 40f398e84f
commit 4c355e42ec
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -6,12 +6,17 @@
Dependency-free C# SDK for interaction with [jpn-cards.com](https://jpn-cards-site.readthedocs.io/en/latest/home/). With the SDK you can gather information about Japanese Pokémon TCG. This includes information about sets and cards, including current price information if available.
The data is provided by an external API. Please check the above link for more information. The SDK only fetches their current JSON data and wraps them into object.
## Installing
The package is available at [Nuget](https://www.nuget.org/packages/JpnCardsPokemon.Sdk/).
**.Net CLI:**: `dotnet add package JpnCardsPokemon.Sdk --version 0.1.0-beta`
**Package manager:** `NuGet\Install-Package JpnCardsPokemon.Sdk -Version 0.1.0-beta`
## Documentation
You can find full documentation [here](docs/index.md).
## Examples
Fetch all sets:
```csharp
var client = new ApiClient();
// fetch all set information
@ -24,5 +29,5 @@ var vmaxClimaxCards = await Client.FetchCardsAsync(new CardQueryFilterBuilder {
var morpekoCards = await Client.FetchCardsAsync(new CardQueryFilterBuilder { Name = "morpeko" });
// fetch all Charizard drawn by Arita
var artiaCharizardCards = await Client.FetchCardsAsync(new CardQueryFilterBuilder { Name = "charizard", Artist = "mitsuhiro arita" });
```
var aritaCharizardCards = await Client.FetchCardsAsync(new CardQueryFilterBuilder { Name = "charizard", Artist = "mitsuhiro arita" });
```