mirror of
https://github.com/tcgdex/cards-database.git
synced 2025-06-13 00:09:18 +00:00
Started some reworks of the META files
Signed-off-by: Avior <florian.bouillon@delta-wings.net>
This commit is contained in:
58
README.md
58
README.md
@ -1,12 +1,32 @@
|
||||
# Pokemon TCGdex
|
||||
<p align="center">
|
||||
<a href="https://www.tcgdex.net">
|
||||
<img src="https://repository-images.githubusercontent.com/241652591/01dd7200-ca01-11eb-98e0-d8f04e7dfe42" width="50%" alt="Discord Link">
|
||||
</a>
|
||||
</p>
|
||||
<p align="center">
|
||||
<a href="https://discord.gg/NehYTAhsZE">
|
||||
<img src="https://img.shields.io/discord/857231041261076491?color=%235865F2&label=Discord" alt="Discord Link">
|
||||
</a>
|
||||
<a href="https://github.com/tcgdex/cards-database/issues">
|
||||
<img src="https://img.shields.io/github/issues/tcgdex/cards-database?style=flat-square&color=%2344CC11" alt="Issue count">
|
||||
</a>
|
||||
<a href="https://github.com/tcgdex/cards-database/stargazers">
|
||||
<img src="https://img.shields.io/github/stars/tcgdex/cards-database?style=flat-square" alt="Github stars">
|
||||
</a>
|
||||
<a href="https://github.com/tcgdex/compiler">
|
||||
<img src="https://img.shields.io/github/workflow/status/tcgdex/compiler/Compile%20TCGdex?style=flat-square" alt="Compiler build passing" />
|
||||
</a>
|
||||
</p>
|
||||
|
||||
A Multilanguage Pokémon TCG Database with Pictures and most of the informations contained on the cards
|
||||
# Pokemon TCGdex Cards Database
|
||||
|
||||
## Use the datas
|
||||
A Multilanguage Pokémon TCG Database with Cards Pictures and most of the informations contained on the cards.
|
||||
|
||||
The easiest way to use the datas is via our [Javascript/Typescript SDK](https://github.com/tcgdex/javascript-sdk).
|
||||
## Interact with the Database
|
||||
|
||||
You can however build this yourself via our [compiler](https://github.com/tcgdex/compiler) or download the already build [compiled database](https://github.com/tcgdex/distribution).
|
||||
The easiest way to interact with the database is by using one of our SDKs _list below_.
|
||||
|
||||
You can however build the API yourself by using our [compiler](https://github.com/tcgdex/compiler) or download the already built [compiled database](https://github.com/tcgdex/distribution).
|
||||
|
||||
## SDKs (API Wrapper but SDK is way cooler 😄)
|
||||
|
||||
@ -15,8 +35,30 @@ We currently officially support theses SDKs
|
||||
- [Javascript/Typescript SDK](https://github.com/tcgdex/javascript-sdk)
|
||||
- [PHP SDK](https://github.com/tcgdex/php-sdk)
|
||||
|
||||
_If you have made a SDK you can start a [discussion](https://github.com/tcgdex/cards-database/discussions/new) to be added here_
|
||||
_If you have a SDK you can start a [discussion](https://github.com/tcgdex/cards-database/discussions/new) to be added here_
|
||||
|
||||
# Contributing
|
||||
|
||||
A card is missing or has incorrect informations? feel free to contribute to the database via the [Issues](https://github.com/tcgdex/cards-database/issues) or with a [Pull Request](https://github.com/tcgdex/cards-database/pulls)
|
||||
## Join Us on Discord
|
||||
|
||||
You have a quation or you just want to discuss anything from an idea/improvement to why Furret should be in the next Pokken Tournament game...
|
||||
|
||||
Well you can join us on [Discord](https://discord.gg/NehYTAhsZE) !
|
||||
|
||||
## Contributing
|
||||
|
||||
See [CONTRIBUTING.md](./CONTRIBUTING.md)
|
||||
|
||||
TD::DR
|
||||
- Fork
|
||||
- make your change
|
||||
- pull request
|
||||
|
||||
## Deprecation
|
||||
|
||||
As of February 2021, the v1 API is no longer supported.
|
||||
|
||||
## License
|
||||
|
||||
This database is not produced, endorsed, supported or affiliated with Nintendo or The Pokémon Company
|
||||
|
||||
The Database is licensed under the MIT License. A copy of the license is available in [LICENSE](./LICENSE)
|
||||
|
Reference in New Issue
Block a user