diff --git a/README.md b/README.md index 4c960fd..21790f5 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,24 @@ # lol-pairing-stat-fetcher -### setup +## setup + +You must copy `example.env` to `.env`, and input your Riot Games API Key to `.env` + +Then run: ```sh npm ci ``` -### running code +## running code -#### with docker-compose +### with docker-compose ```sh docker-compose up ``` -#### on its own +### on its own Note: you will need to provide your own redis, or disable redis caching by switching from `"ioredis"` to `"local"` @@ -22,7 +26,7 @@ Note: you will need to provide your own redis, or disable redis caching by switc npm start ``` -##### with cache debugging +#### with cache debugging ```sh npm run debug-cache