Skip to content

Commit

Permalink
docs: fix installation instructions and details in readme (#75)
Browse files Browse the repository at this point in the history
  • Loading branch information
rohilsurana authored Jul 14, 2022
1 parent 69035eb commit 56ecf79
Showing 1 changed file with 3 additions and 6 deletions.
9 changes: 3 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,18 +36,15 @@ in your PATH for easy use. `/usr/local/bin` is the most probable location.

```sh
# Install entropy (requires homebrew installed)
$ brew install odpf/taps/entropy

# Upgrade entropy (requires homebrew installed)
$ brew upgrade entropy
$ brew install odpf/tap/entropy

# Check for installed entropy version
$ entropy version
```

## Usage

Entropy typically runs as a service and requires a MongoDB to store its state.
Entropy typically runs as a service and requires a Postgres to store its state.

## Running locally

Expand All @@ -62,7 +59,7 @@ $ make build
$ docker-compose up

# Run entropy on a recipe file
$ ./entropy serve
$ ./dist/entropy serve

```

Expand Down

0 comments on commit 56ecf79

Please sign in to comment.