diff --git a/README.md b/README.md new file mode 100644 index 0000000..4c960fd --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# lol-pairing-stat-fetcher + +### setup + +```sh +npm ci +``` + +### running code + +#### with docker-compose + +```sh +docker-compose up +``` + +#### on its own + +Note: you will need to provide your own redis, or disable redis caching by switching from `"ioredis"` to `"local"` + +```sh +npm start +``` + +##### with cache debugging + +```sh +npm run debug-cache +```