Skip to content

Commit

Permalink
README: Add compatibility and installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
GeertJohan committed Jan 7, 2024
1 parent 581c6d8 commit 4b43334
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
# trek

## Requirements
At least version 13 of postgres is needed.
## Compatibility

Trek works with PostgreSQL version 13 or newer. We build trek with the latest stable version of pgModeler.

## Installation

```bash
go install .
go install github.com/printeers/trek@latest
```

Or use a [released docker image](https://github.com/printeers/trek/pkgs/container/trek).

## Dependencies

Trek depends on `migra` and `pgmodeler-cli`. Trek will try to locate these in the `$PATH` of the user.
Expand Down

0 comments on commit 4b43334

Please sign in to comment.