Skip to content

Commit

Permalink
add cache note to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
benleb committed Aug 13, 2022
1 parent 15c4b8f commit fb3a807
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,23 @@
- get an account at [Infura](https://infura.io)/[Alchemy](https://www.alchemy.com)/*whatever* to get a websockets endpoint to an ethereum node
***wss://mainnet.infura.io/ws/v3/32e98f6ffb81456df24087ab5b***

## recommended ☝️

‼️ use [redis](https://redis.io) as cache for collection & ENS names! it saves a lot of (limited) calls to a node and is also faster than calls to a node. you can use the [redis docker image](https://hub.docker.com/_/redis) for this or [install redis](https://redis.io/docs/getting-started/installation/) on a local machine.

most simple configuration example with `redis` running on `10.0.0.2:6379` (default port, database and no password):

```yaml
# redis cache
redis:
# use redis as name & sale cache
enabled: true
# redis host
host: 10.0.0.2
```

there is also an ultra-simple built-in cache but without any persistence and therefore empty on every new start of `gloomberg`.

## lfg! or *getting started*

```bash
Expand Down

0 comments on commit fb3a807

Please sign in to comment.