From 5315c9511ddeb5df048948f711d304ba682fc459 Mon Sep 17 00:00:00 2001 From: Avior Date: Wed, 11 Mar 2020 10:13:00 +0100 Subject: [PATCH] Made Better REAADME Signed-off-by: Avior --- README.md | 46 +++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 41 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 7823963..938ce13 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,44 @@ -current endpoints +# TCGdex Javacript SDK -```js - console.log(await tcgdex.getCard("1", "hgss1")) - console.log(await tcgdex.getSet("hgss1")) - console.log(await tcgdex.getExpansion("hgss")) +## Install +### Yarn/npm + +```bash +yarn add @tcgdex/sdk +``` +or with npm +```bash +npm install @tcgdex/sdk +``` + +## Usage + +_Note: a complete documentation is in progress_ + +```javascript +import TCGdex from '@tcgdex/sdk' +import TranslationUtil from '@tcgdex/sdk/TranslationUtil' +import Tag from '@tcgdex/sdk/interfaces/Tag' + +// init the class +const tcgdex = new TCGdex("en") // Lang code (Optionnal) (See TranslationUtil.ts line 3) + +// change lang +tcgdex.lang = "fr" + +// get Card object wih global id +await tcgdex.getCard("base1-1") + +// get Card object with local id and set +await tcgdex.getCard(1, "base1") + +// get Set informations +await tcgdex.getSet("base1") + +// get Expansion +await tcgdex.getExpansion("base") + +// Translate information from code to the lang +TranslationUtil.translate("tag", Tag.STAGE2, "en") ```