Updates Readme

This commit is contained in:
Serraniel 2023-03-03 19:16:12 +01:00
parent a53ae6e727
commit 354527e1f4
Signed by: Serraniel
GPG key ID: 3690B4E7364525D3

View file

@ -1,2 +1,24 @@
# japanese-pokemon-cards-sdk-csharp # japanese-pokemon-cards-sdk-csharp
C# SDK for interaction with jpn-cards.com 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.
## Documentation
You can find full documentation [here](docs/index.md).
## Examples
Fetch all sets:
```csharp
var client = new ApiClient();
// fetch all set information
var sets = await client.FetchSetsAsync();
// fetch cards from set
var vmaxClimaxCards = await Client.FetchCardsAsync(new CardQueryFilterBuilder { SetCode = "s12a" });
// fetch all morpeko cards
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" });
```