Skip to content

Commit

Permalink
Adjust README
Browse files Browse the repository at this point in the history
  • Loading branch information
davenquinn committed Mar 7, 2024
1 parent ef26be3 commit 84e741a
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ cd macrostrat-api
Next, install dependencies:

```
npm install
yarn install
```

NOTE: Postgres connections are completely broken in node v14 and v15 (as of
Expand All @@ -45,12 +45,11 @@ NOTE: Postgres connections are completely broken in node v14 and v15 (as of
This will also run the script `postinstall.sh` which copies credentials files
into place.

For `v1/credentials.js` fill in your MariaDB and PostgreSQL user information. Do
the same for `v2/credentials.js`, but also update the port for Redis if
necessary, and follow the inline instructions for generating a cache refresh
key. The cache refresh key is used as a secret parameter to programmatically
refresh the column cache, such as in situations in which the underlying data has
been changed (editing, adding, etc).
For `credentials.ts` fill in your MariaDB and PostgreSQL user information,
update the port for Redis if necessary, and follow the inline instructions for
generating a cache refresh key. The cache refresh key is used as a secret
parameter to programmatically refresh the column cache, such as in situations in
which the underlying data has been changed (editing, adding, etc).

## Running

Expand Down

0 comments on commit 84e741a

Please sign in to comment.