diff --git a/README.md b/README.md index 736a16b..a182af5 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,45 @@ # mkm junk rare finder -## Build rare db +## Requirements + +- Node +- yarn + +## How to use + +### Get dependencies + +Just run `yarn` + +### Get API keys + +Go to https://www.cardmarket.com/en/Magic/Account/API and create a Dedicated app. + +Put the keys in your environment like so: + +```sh +export APP_TOKEN= +export APP_SECRET= +export ACCESS_TOKEN= +export ACCESS_SECRET= +``` + +### Build card db To use the rare finder, you'll need to build the rare db 1. Download this: https://www.mtgjson.com/files/AllPrintings.json -2. Run `yarn convert-db` +2. Run `yarn import-db` + +It will create a file called `mcmCards.json` + +## Fetch all cards listed by a user + +1. `yarn fetch ` +2. `yarn find ` + +User ID can be either a username or user id on cardmarket + +## Create a cube out of the cheap rares! + +WIP, will be `yarn cube ` \ No newline at end of file