From 354527e1f4c09144985ab30d67fe97317575aaa4 Mon Sep 17 00:00:00 2001 From: Serraniel Date: Fri, 3 Mar 2023 19:16:12 +0100 Subject: [PATCH] Updates Readme --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ed69a8b..fbd0551 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,24 @@ # 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" }); +``` \ No newline at end of file