Made Better REAADME

Signed-off-by: Avior <florian.bouillon@delta-wings.net>
This commit is contained in:
Florian Bouillon 2020-03-11 10:13:00 +01:00
parent 561ec85545
commit 5315c9511d
No known key found for this signature in database
GPG Key ID: B143FF27EF555D16

View File

@ -1,8 +1,44 @@
current endpoints # TCGdex Javacript SDK
```js ## Install
console.log(await tcgdex.getCard("1", "hgss1"))
console.log(await tcgdex.getSet("hgss1"))
console.log(await tcgdex.getExpansion("hgss"))
### 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")
``` ```