Skip to content

Commit

Permalink
Add installation instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
mattrobenolt committed Oct 19, 2023
1 parent 4da25b1 commit 620d3a9
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 1 deletion.
5 changes: 4 additions & 1 deletion Makefile
Expand Up @@ -75,4 +75,7 @@ docker:
run-mysql:
docker run -it --rm --name $(app)-mysqld -e MYSQL_ALLOW_EMPTY_PASSWORD="true" -e MYSQL_ROOT_PASSWORD="" -p 127.0.0.1:3306:3306 mysql:8.0.29

.PHONY: all proto clean clean-proto clean-bin clean-dist tools run run-mysql
publish: clean $(BIN)/goreleaser
$(BIN)/goreleaser release

.PHONY: all proto clean clean-proto clean-bin clean-dist tools run run-mysql publish
22 changes: 22 additions & 0 deletions README.md
Expand Up @@ -6,6 +6,28 @@ At the moment, this is not an official PlanetScale project, and is in early stag

This is intended to aid when adopting `@planetscale/database` in your application and wanting to run against a local database.

Please open issues for bugs or any feedback.

# Installation

## Binaries

Compiled binaries can be found in GitHub Releases: https://github.com/mattrobenolt/ps-http-sim/releases

## Build from source

Go is required:

```
$ go install github.com/mattrobenolt/ps-http-sim@latest
```

or from within this repository:

```
$ make
```

# Usage

```
Expand Down

0 comments on commit 620d3a9

Please sign in to comment.