From 83cfaed1a38079d9ac110f00705af580157817b1 Mon Sep 17 00:00:00 2001 From: Alex Haiut Date: Thu, 19 Aug 2021 11:47:02 +0300 Subject: [PATCH] updated readme for release (#237) --- cli/Makefile | 2 +- cli/README.md.TEMPLATE | 20 ++++++++++++++++++++ 2 files changed, 21 insertions(+), 1 deletion(-) create mode 100644 cli/README.md.TEMPLATE diff --git a/cli/Makefile b/cli/Makefile index 279f95213..dd77c510d 100644 --- a/cli/Makefile +++ b/cli/Makefile @@ -24,7 +24,7 @@ build: ## Build mizu CLI binary (select platform via GOOS / GOARCH env variables build-all: ## Build for all supported platforms. @echo "Compiling for every OS and Platform" - @mkdir -p bin && echo "SHA256 checksums available for compiled binaries \n\nRun \`shasum -a 256 -c mizu_OS_ARCH.sha256\` to verify\n\n" > bin/README.md + @mkdir -p bin && sed s/_SEM_VER_/$(SEM_VER)/g README.md.TEMPLATE > bin/README.md @$(MAKE) build GOOS=darwin GOARCH=amd64 @$(MAKE) build GOOS=linux GOARCH=amd64 @# $(MAKE) build GOOS=darwin GOARCH=arm64 diff --git a/cli/README.md.TEMPLATE b/cli/README.md.TEMPLATE new file mode 100644 index 000000000..83288847f --- /dev/null +++ b/cli/README.md.TEMPLATE @@ -0,0 +1,20 @@ +# Mizu release _SEM_VER_ + +Download Mizu for your platform + +**Mac** (on Intel chip) +``` +curl -Lo mizu https://github.com/up9inc/mizu/releases/download/_SEM_VER_/mizu_darwin_amd64 && chmod 755 mizu +``` + +**Linux** +``` +curl -Lo mizu https://github.com/up9inc/mizu/releases/download/_SEM_VER_/mizu_linux_amd64 && chmod 755 mizu +``` + + +### Checksums +SHA256 checksums available for compiled binaries. +Run `shasum -a 256 -c mizu_OS_ARCH.sha256` to verify. + +