From 620d3a93f8a61f52fec45ba06fdfcf99eae59e22 Mon Sep 17 00:00:00 2001 From: Matt Robenolt Date: Wed, 18 Oct 2023 18:27:46 -0700 Subject: [PATCH] Add installation instructions to README --- Makefile | 5 ++++- README.md | 22 ++++++++++++++++++++++ 2 files changed, 26 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 8ec244f..5b6d507 100644 --- a/Makefile +++ b/Makefile @@ -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 diff --git a/README.md b/README.md index 4e073b4..74806b2 100644 --- a/README.md +++ b/README.md @@ -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 ```