From 7ef3ddc540f4b342dbe1df5c3fc717fc4e824688 Mon Sep 17 00:00:00 2001 From: Simon Barendse Date: Tue, 26 Mar 2019 18:59:58 +0100 Subject: [PATCH 01/26] Add a README --- README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 52 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 447dfc78..8462a1e5 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,52 @@ -# secrethub-cli -Command-line interface for SecretHub +# SecretHub CLI + +[![GoDoc](http://img.shields.io/badge/godoc-reference-blue.svg)][godoc] +[![Travis CI](https://travis-ci.org/secrethub/secrethub-cli.svg?branch=master)][travis-ci] +[![GolangCI](https://golangci.com/badges/github.com/secrethub/secrethub-cli.svg)][golang-ci] +[![Go Report Card](https://goreportcard.com/badge/github.com/secrethub/secrethub-cli)][goreportcard] + +SecretHub + +--- + +[SecretHub][secrethub] is a developer tool to help you keep database passwords, API tokens, and other secrets out of IT automation scripts. + +`secrethub-cli` provides the command line interface to interact with the SecretHub server. + +## Installation + +Binaries are provided in the [GitHub releases][releases]. Place the binary of your OS in the PATH and you are good to go! + +We plan to distribute secrethub via package managers ([#1](https://github.com/secrethub/secrethub-cli/issues/1)). +Please feel free to join the discussion and let us know what package manager you are using. + +## Usage + +Checkout the [getting started docs](https://secrethub.io/docs/getting-started/). +Or have a look at the [reference docs](https://secrethub.io/docs/reference/) when you are looking for documentation about a specific command. + +## Development + +Pull requests from the community are welcome. +If you'd like to contribute, please checkout [the contributing guidelines](./CONTRIBUTING.md). + +## Test + +Run all tests: + + make test + +Run tests for one package: + + go test ./internals/secrethub + +Run a single test: + + go test ./internals/secrethub -run TestWriteCommand_Run + +[secrethub]: https://secrethub.io +[releases]: https://github.com/secrethub/secrethub-cli/releases +[godoc]: http://godoc.org/github.com/secrethub/secrethub-cli +[golang-ci]: https://golangci.com/r/github.com/secrethub/secrethub-cli +[goreportcard]: https://goreportcard.com/report/github.com/secrethub/secrethub-cli +[travis-ci]: https://travis-ci.org/secrethub/secrethub-cli From bc9f725a26552bfa8643ae174c959e9bf1cabdef Mon Sep 17 00:00:00 2001 From: Simon Barendse Date: Wed, 27 Mar 2019 13:21:14 +0100 Subject: [PATCH 02/26] Rephrase server => API in the readme To the outside world, we provide an API, not a server. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8462a1e5..2cb840cc 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ [SecretHub][secrethub] is a developer tool to help you keep database passwords, API tokens, and other secrets out of IT automation scripts. -`secrethub-cli` provides the command line interface to interact with the SecretHub server. +`secrethub-cli` provides the command line interface to interact with the SecretHub API. ## Installation From 2ee0750614748e89ea0a0f3c21842e525e1327a5 Mon Sep 17 00:00:00 2001 From: Simon Barendse Date: Wed, 27 Mar 2019 14:51:43 +0100 Subject: [PATCH 03/26] Update issue number of package manager distribution issue --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2cb840cc..0fb6e9b0 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Binaries are provided in the [GitHub releases][releases]. Place the binary of your OS in the PATH and you are good to go! -We plan to distribute secrethub via package managers ([#1](https://github.com/secrethub/secrethub-cli/issues/1)). +We plan to distribute secrethub via package managers ([#27](https://github.com/secrethub/secrethub-cli/issues/27)). Please feel free to join the discussion and let us know what package manager you are using. ## Usage From cffa43bce779533a7954112803b7236d672decad Mon Sep 17 00:00:00 2001 From: Simon Barendse Date: Wed, 27 Mar 2019 15:11:11 +0100 Subject: [PATCH 04/26] Add make commands to build and install from source --- Makefile | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/Makefile b/Makefile index b41811b3..f5c3b414 100644 --- a/Makefile +++ b/Makefile @@ -16,3 +16,13 @@ format-tools: lint-tools: @curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | sh -s -- -b $(go env GOPATH)/bin v1.15.0 + +COMMIT=`git rev-parse --short HEAD` +VERSION=`git describe --always` +BUILD_FLAGS=-ldflags "-s -w -X main.commit=${COMMIT} -X main.version=${VERSION}" -tags=production + +build: + go build ${BUILD_FLAGS} ./cmd/secrethub + +install: + go install ${BUILD_FLAGS} ./cmd/secrethub From 4495196f3269c31c64bee579c18dd0dcea687561 Mon Sep 17 00:00:00 2001 From: Simon Barendse Date: Wed, 27 Mar 2019 15:18:04 +0100 Subject: [PATCH 05/26] Add more complete installation instructions - Add how to extract and add to the PATH - Add how to install from source --- README.md | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0fb6e9b0..6e37a8b1 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,36 @@ ## Installation -Binaries are provided in the [GitHub releases][releases]. Place the binary of your OS in the PATH and you are good to go! +### Download + +Official binary distributions are available for the Linux, macOS, and Windows operating systems for both the 32-bit (386) and 64-bit (amd64) versions. +You can find the latest release [here][releases]. + +To install the SecretHub CLI, download the archive file appropriate for your operating system and extract it e.g. to `/usr/local/secrethub`. + +```sh +mkdir /usr/local/secrethub +tar -C /usr/local/secrethub -xzf secrethub-VERSION-OS-ARCH.tar.gz +``` + +Ensure it is accessible through the PATH environment variable. +```sh +export PATH=$PATH:/usr/local/secrethub +``` + +Verify your installation works by running the following command: +```sh +secrethub --version +``` + +### Install from source + +To build the binary from source, run: +```sh +make install +``` + +### Install via a package manager We plan to distribute secrethub via package managers ([#27](https://github.com/secrethub/secrethub-cli/issues/27)). Please feel free to join the discussion and let us know what package manager you are using. From 1df55e3ae2dfee33745f9227239f618e1492bc26 Mon Sep 17 00:00:00 2001 From: Simon Barendse Date: Wed, 27 Mar 2019 15:21:03 +0100 Subject: [PATCH 06/26] Add instructions on installing auto-completion --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 6e37a8b1..8300770a 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,19 @@ make install We plan to distribute secrethub via package managers ([#27](https://github.com/secrethub/secrethub-cli/issues/27)). Please feel free to join the discussion and let us know what package manager you are using. +## Install auto-completion + +To install auto completion for the CLI, run one of the following commands depending on your shell of choice: + +```sh +# Install bash completion +secrethub --completion-script-bash > /etc/bash_completion.d/secrethub +``` +```sh +# Install zsh completion +secrethub --completion-script-zsh > ~/.zsh/completion/secrethub +``` + ## Usage Checkout the [getting started docs](https://secrethub.io/docs/getting-started/). From 94552c9be96c7b5880ede7d262308aa86a6f2976 Mon Sep 17 00:00:00 2001 From: Simon Barendse Date: Wed, 27 Mar 2019 15:23:09 +0100 Subject: [PATCH 07/26] Rephrase reference docs line --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8300770a..c1310af2 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,7 @@ secrethub --completion-script-zsh > ~/.zsh/completion/secrethub ## Usage Checkout the [getting started docs](https://secrethub.io/docs/getting-started/). -Or have a look at the [reference docs](https://secrethub.io/docs/reference/) when you are looking for documentation about a specific command. +Or have a look at the [reference docs](https://secrethub.io/docs/reference/) where each command is documented in detail. ## Development From b7e9f0cb6af2c9b90b41f7369ff780523ab4a089 Mon Sep 17 00:00:00 2001 From: Simon Barendse Date: Wed, 27 Mar 2019 16:38:24 +0100 Subject: [PATCH 08/26] Rename Usage header to Getting started --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c1310af2..16e7eecf 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,7 @@ secrethub --completion-script-bash > /etc/bash_completion.d/secrethub secrethub --completion-script-zsh > ~/.zsh/completion/secrethub ``` -## Usage +## Getting started Checkout the [getting started docs](https://secrethub.io/docs/getting-started/). Or have a look at the [reference docs](https://secrethub.io/docs/reference/) where each command is documented in detail. From 62d30a54b1a0f9ccd83781d22e750cb33c405960 Mon Sep 17 00:00:00 2001 From: Simon Barendse Date: Wed, 27 Mar 2019 16:39:54 +0100 Subject: [PATCH 09/26] Add ticks around PATH --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 16e7eecf..9f3ce662 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ mkdir /usr/local/secrethub tar -C /usr/local/secrethub -xzf secrethub-VERSION-OS-ARCH.tar.gz ``` -Ensure it is accessible through the PATH environment variable. +Ensure it is accessible through the `PATH` environment variable. ```sh export PATH=$PATH:/usr/local/secrethub ``` From f6ff70f2d2c72ff8953c070676c72e2e284939bb Mon Sep 17 00:00:00 2001 From: Simon Barendse Date: Wed, 27 Mar 2019 16:41:58 +0100 Subject: [PATCH 10/26] Adapt installation headers --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9f3ce662..dfe3e982 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ ## Installation -### Download +### Download a binary distribution Official binary distributions are available for the Linux, macOS, and Windows operating systems for both the 32-bit (386) and 64-bit (amd64) versions. You can find the latest release [here][releases]. @@ -37,14 +37,14 @@ Verify your installation works by running the following command: secrethub --version ``` -### Install from source +### Build from source To build the binary from source, run: ```sh make install ``` -### Install via a package manager +### Use a package manager We plan to distribute secrethub via package managers ([#27](https://github.com/secrethub/secrethub-cli/issues/27)). Please feel free to join the discussion and let us know what package manager you are using. From dd27a150176fc871f81d56a0f44bc66cf0fdc82d Mon Sep 17 00:00:00 2001 From: Simon Barendse Date: Wed, 27 Mar 2019 17:03:02 +0100 Subject: [PATCH 11/26] Add make build and explain go install requirements --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dfe3e982..d2995519 100644 --- a/README.md +++ b/README.md @@ -39,11 +39,23 @@ secrethub --version ### Build from source -To build the binary from source, run: +To build from source, [GoLang](https://golang.org) is required. + +To install the binary in the [GOBIN](https://golang.org/cmd/go/#hdr-GOPATH_environment_variable), run: ```sh make install ``` +Alternatively, to build the binary in the current directory, run: +```sh +make build +``` + +Now you can move it into the `PATH` to use it from any directory: +```sh +mv ./secrethub /usr/local/bin/ +``` + ### Use a package manager We plan to distribute secrethub via package managers ([#27](https://github.com/secrethub/secrethub-cli/issues/27)). From 723befd35a0fab3b9803375cb847ef88b34ecd08 Mon Sep 17 00:00:00 2001 From: Simon Barendse Date: Wed, 27 Mar 2019 17:04:14 +0100 Subject: [PATCH 12/26] Add test under development --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d2995519..fc037a47 100644 --- a/README.md +++ b/README.md @@ -84,7 +84,7 @@ Or have a look at the [reference docs](https://secrethub.io/docs/reference/) whe Pull requests from the community are welcome. If you'd like to contribute, please checkout [the contributing guidelines](./CONTRIBUTING.md). -## Test +### Test Run all tests: From 1d7066c79f71222acacf6c2b22a7fff23a880500 Mon Sep 17 00:00:00 2001 From: Simon Barendse Date: Wed, 27 Mar 2019 17:17:23 +0100 Subject: [PATCH 13/26] Add a getting help section to the readme --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index fc037a47..49b8077b 100644 --- a/README.md +++ b/README.md @@ -98,9 +98,14 @@ Run a single test: go test ./internals/secrethub -run TestWriteCommand_Run +## Getting help + +Please reach out on [Discord][discord-cli] or via email ([support@secrethub.io](mailto:support@secrethub.io)) if you have any questions. We're here to help. + [secrethub]: https://secrethub.io [releases]: https://github.com/secrethub/secrethub-cli/releases [godoc]: http://godoc.org/github.com/secrethub/secrethub-cli [golang-ci]: https://golangci.com/r/github.com/secrethub/secrethub-cli [goreportcard]: https://goreportcard.com/report/github.com/secrethub/secrethub-cli [travis-ci]: https://travis-ci.org/secrethub/secrethub-cli +[discord-cli]: https://discordapp.com/channels/554666183006224385/554685208486608906 From ac88f284cfafbd3674409971892fa845f2dee383 Mon Sep 17 00:00:00 2001 From: Simon Barendse Date: Wed, 27 Mar 2019 17:22:40 +0100 Subject: [PATCH 14/26] Add uninstalling instructions --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 49b8077b..fbc4af3c 100644 --- a/README.md +++ b/README.md @@ -98,6 +98,15 @@ Run a single test: go test ./internals/secrethub -run TestWriteCommand_Run +## Uninstalling + +To remove an existing SecretHub installation from your system delete the secrethub directory. +This is usually `/usr/local/secrethub` under Linux, macOS, and FreeBSD or `c:\SecretHub` under Windows. + +You should also remove the SecretHub directory from your PATH environment variable. + +If you've installed auto-completion, you should remove either `/etc/bash_completion.d/secrethub` or `~/.zsh/completion/secrethub`. + ## Getting help Please reach out on [Discord][discord-cli] or via email ([support@secrethub.io](mailto:support@secrethub.io)) if you have any questions. We're here to help. From ab2ef310b10b359df958a989dc653d05e6ad87ab Mon Sep 17 00:00:00 2001 From: Simon Barendse Date: Wed, 27 Mar 2019 17:25:09 +0100 Subject: [PATCH 15/26] Move verification of the installation to its own section --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index fbc4af3c..d6d5e04e 100644 --- a/README.md +++ b/README.md @@ -32,11 +32,6 @@ Ensure it is accessible through the `PATH` environment variable. export PATH=$PATH:/usr/local/secrethub ``` -Verify your installation works by running the following command: -```sh -secrethub --version -``` - ### Build from source To build from source, [GoLang](https://golang.org) is required. @@ -61,6 +56,13 @@ mv ./secrethub /usr/local/bin/ We plan to distribute secrethub via package managers ([#27](https://github.com/secrethub/secrethub-cli/issues/27)). Please feel free to join the discussion and let us know what package manager you are using. +## Test your installation + +Verify your installation works by running the following command: +```sh +secrethub --version +``` + ## Install auto-completion To install auto completion for the CLI, run one of the following commands depending on your shell of choice: From 02b91518fe23da795cdf8c504db1102c4893ad5e Mon Sep 17 00:00:00 2001 From: Simon Barendse Date: Wed, 27 Mar 2019 17:30:04 +0100 Subject: [PATCH 16/26] Add a table of contents --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index d6d5e04e..b21cce04 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,14 @@ `secrethub-cli` provides the command line interface to interact with the SecretHub API. +1. [Installation](#installation) +1. [Test your installation](#test-your-installation) +1. [Install auto-completion](#install-auto-completion) +1. [Getting Started](#getting-started) +1. [Development](#development) +1. [Uninstalling](#uninstalling) +1. [Getting Help](#getting-help) + ## Installation ### Download a binary distribution From 7a7f9b966a8a9ce85526ac3f92620c5017592a00 Mon Sep 17 00:00:00 2001 From: Simon Barendse Date: Wed, 27 Mar 2019 17:32:52 +0100 Subject: [PATCH 17/26] Swap discord URL with an invite URL --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b21cce04..b9000b3a 100644 --- a/README.md +++ b/README.md @@ -127,4 +127,4 @@ Please reach out on [Discord][discord-cli] or via email ([support@secrethub.io]( [golang-ci]: https://golangci.com/r/github.com/secrethub/secrethub-cli [goreportcard]: https://goreportcard.com/report/github.com/secrethub/secrethub-cli [travis-ci]: https://travis-ci.org/secrethub/secrethub-cli -[discord-cli]: https://discordapp.com/channels/554666183006224385/554685208486608906 +[discord-cli]: https://discord.gg/Wut4KUK From 662cdb57c2afaf9de5daef818ad5f8973ace2eb4 Mon Sep 17 00:00:00 2001 From: Simon Barendse Date: Wed, 27 Mar 2019 17:39:55 +0100 Subject: [PATCH 18/26] Add a Discord badge --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index b9000b3a..b8e28531 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ [![Travis CI](https://travis-ci.org/secrethub/secrethub-cli.svg?branch=master)][travis-ci] [![GolangCI](https://golangci.com/badges/github.com/secrethub/secrethub-cli.svg)][golang-ci] [![Go Report Card](https://goreportcard.com/badge/github.com/secrethub/secrethub-cli)][goreportcard] +[![Discord](https://img.shields.io/badge/discord-SecretHub-7289da.svg?logo=discord)][discord-cli] SecretHub From 407a5c9cb14049775aa8b18c22e6a6c14138039b Mon Sep 17 00:00:00 2001 From: Simon Barendse Date: Wed, 27 Mar 2019 17:40:05 +0100 Subject: [PATCH 19/26] Revert "Add a table of contents" This reverts commit 02b91518fe23da795cdf8c504db1102c4893ad5e. --- README.md | 8 -------- 1 file changed, 8 deletions(-) diff --git a/README.md b/README.md index b8e28531..e7855106 100644 --- a/README.md +++ b/README.md @@ -14,14 +14,6 @@ `secrethub-cli` provides the command line interface to interact with the SecretHub API. -1. [Installation](#installation) -1. [Test your installation](#test-your-installation) -1. [Install auto-completion](#install-auto-completion) -1. [Getting Started](#getting-started) -1. [Development](#development) -1. [Uninstalling](#uninstalling) -1. [Getting Help](#getting-help) - ## Installation ### Download a binary distribution From 5b2e2fa2bc121e53bb5941d9633fdd9459b63e1d Mon Sep 17 00:00:00 2001 From: Simon Barendse Date: Wed, 27 Mar 2019 17:42:52 +0100 Subject: [PATCH 20/26] Update the discord URL to one where you're invited by SecretHub Now the invite comes from SecretHub instead of Simon Barendse --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e7855106..cac166da 100644 --- a/README.md +++ b/README.md @@ -120,4 +120,4 @@ Please reach out on [Discord][discord-cli] or via email ([support@secrethub.io]( [golang-ci]: https://golangci.com/r/github.com/secrethub/secrethub-cli [goreportcard]: https://goreportcard.com/report/github.com/secrethub/secrethub-cli [travis-ci]: https://travis-ci.org/secrethub/secrethub-cli -[discord-cli]: https://discord.gg/Wut4KUK +[discord-cli]: https://discord.gg/gyQXAFU From a9705a08e6942f15e1c23f590430fe653898767a Mon Sep 17 00:00:00 2001 From: Simon Barendse Date: Wed, 27 Mar 2019 17:49:41 +0100 Subject: [PATCH 21/26] Rephrase the getting help sentence --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cac166da..488a7156 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![Travis CI](https://travis-ci.org/secrethub/secrethub-cli.svg?branch=master)][travis-ci] [![GolangCI](https://golangci.com/badges/github.com/secrethub/secrethub-cli.svg)][golang-ci] [![Go Report Card](https://goreportcard.com/badge/github.com/secrethub/secrethub-cli)][goreportcard] -[![Discord](https://img.shields.io/badge/discord-SecretHub-7289da.svg?logo=discord)][discord-cli] +[![Discord](https://img.shields.io/badge/discord-SecretHub-7289da.svg?logo=discord)][discord] SecretHub @@ -112,7 +112,7 @@ If you've installed auto-completion, you should remove either `/etc/bash_complet ## Getting help -Please reach out on [Discord][discord-cli] or via email ([support@secrethub.io](mailto:support@secrethub.io)) if you have any questions. We're here to help. +Come chat with us on [Discord][discord] or email us at [support@secrethub.io](mailto:support@secrethub.io) [secrethub]: https://secrethub.io [releases]: https://github.com/secrethub/secrethub-cli/releases @@ -120,4 +120,4 @@ Please reach out on [Discord][discord-cli] or via email ([support@secrethub.io]( [golang-ci]: https://golangci.com/r/github.com/secrethub/secrethub-cli [goreportcard]: https://goreportcard.com/report/github.com/secrethub/secrethub-cli [travis-ci]: https://travis-ci.org/secrethub/secrethub-cli -[discord-cli]: https://discord.gg/gyQXAFU +[discord]: https://discord.gg/gyQXAFU From 820a8214aee80dfd16acbfd285a3fb069750633a Mon Sep 17 00:00:00 2001 From: Simon Barendse Date: Wed, 27 Mar 2019 17:56:31 +0100 Subject: [PATCH 22/26] Only name linux and macos in uninstall instructions --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 488a7156..8efac0a8 100644 --- a/README.md +++ b/README.md @@ -104,7 +104,7 @@ Run a single test: ## Uninstalling To remove an existing SecretHub installation from your system delete the secrethub directory. -This is usually `/usr/local/secrethub` under Linux, macOS, and FreeBSD or `c:\SecretHub` under Windows. +This is usually `/usr/local/secrethub` under Linux and macOS. You should also remove the SecretHub directory from your PATH environment variable. From ab293b09bfd3f84e2b63a412e61b9bc73da6acc7 Mon Sep 17 00:00:00 2001 From: Simon Barendse Date: Wed, 27 Mar 2019 17:57:14 +0100 Subject: [PATCH 23/26] Add ticks around the PATH --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8efac0a8..8dadd583 100644 --- a/README.md +++ b/README.md @@ -106,7 +106,7 @@ Run a single test: To remove an existing SecretHub installation from your system delete the secrethub directory. This is usually `/usr/local/secrethub` under Linux and macOS. -You should also remove the SecretHub directory from your PATH environment variable. +You should also remove the SecretHub directory from your `PATH` environment variable. If you've installed auto-completion, you should remove either `/etc/bash_completion.d/secrethub` or `~/.zsh/completion/secrethub`. From 72431a92ec7e7a5e4650b2de23362f9d2eee94f0 Mon Sep 17 00:00:00 2001 From: Simon Barendse Date: Wed, 27 Mar 2019 17:57:55 +0100 Subject: [PATCH 24/26] Use ticks around the secrethub directory name --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8dadd583..53a85c75 100644 --- a/README.md +++ b/README.md @@ -103,7 +103,7 @@ Run a single test: ## Uninstalling -To remove an existing SecretHub installation from your system delete the secrethub directory. +To remove an existing SecretHub installation from your system delete the `secrethub` directory. This is usually `/usr/local/secrethub` under Linux and macOS. You should also remove the SecretHub directory from your `PATH` environment variable. From 25d17cb8fe18e991bf9c711ec564f4f92dea6091 Mon Sep 17 00:00:00 2001 From: Simon Barendse Date: Wed, 27 Mar 2019 18:00:29 +0100 Subject: [PATCH 25/26] Rephrase install in the GOBIN directory --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 53a85c75..de27f59a 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ export PATH=$PATH:/usr/local/secrethub To build from source, [GoLang](https://golang.org) is required. -To install the binary in the [GOBIN](https://golang.org/cmd/go/#hdr-GOPATH_environment_variable), run: +To install the binary in the [GOBIN](https://golang.org/cmd/go/#hdr-GOPATH_environment_variable) directory, run: ```sh make install ``` From c62f4151003c7e45250973e3a736ddfec142c5ad Mon Sep 17 00:00:00 2001 From: Simon Barendse Date: Wed, 27 Mar 2019 18:11:13 +0100 Subject: [PATCH 26/26] Use the new standard of the readme header --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index de27f59a..cf89dec8 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,9 @@ -# SecretHub CLI +

+ SecretHub +

+

+ CLI +

[![GoDoc](http://img.shields.io/badge/godoc-reference-blue.svg)][godoc] [![Travis CI](https://travis-ci.org/secrethub/secrethub-cli.svg?branch=master)][travis-ci] @@ -6,13 +11,9 @@ [![Go Report Card](https://goreportcard.com/badge/github.com/secrethub/secrethub-cli)][goreportcard] [![Discord](https://img.shields.io/badge/discord-SecretHub-7289da.svg?logo=discord)][discord] -SecretHub +The SecretHub CLI provides the command-line interface to interact with SecretHub. ---- - -[SecretHub][secrethub] is a developer tool to help you keep database passwords, API tokens, and other secrets out of IT automation scripts. - -`secrethub-cli` provides the command line interface to interact with the SecretHub API. +> [SecretHub][secrethub] is a developer tool to help you keep database passwords, API tokens, and other secrets out of IT automation scripts. ## Installation