add README.md

This commit is contained in:
Zynh0722 2024-02-08 19:46:41 -08:00
parent 82108a0f3f
commit f45cc2cd1c

29
README.md Normal file
View file

@ -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
```