From 32234e1fb82d6862ff16c1c46d9207bcd6f24431 Mon Sep 17 00:00:00 2001 From: Jean-Francis Bastien Date: Tue, 27 Feb 2024 19:35:55 -0500 Subject: [PATCH] update readme --- README.md | 30 +++++++++++++++++++----------- 1 file changed, 19 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index d436820..bac683c 100644 --- a/README.md +++ b/README.md @@ -18,25 +18,33 @@ The `sync` command will do: ## Installation -⚠️ Binary are not signed, you will need to allow it to run on your system. The tool is still in development. +Only **MacOS** is supported for now via Homebrew. -Go to [releases](https://github.com/Bhacaz/gostacking/releases/latest) and download the binary or compile it yourself. +```bash +brew tap Bhacaz/tap +brew install gostacking +brew link gostacking +``` ## Commands Usage: `gostacking [command]` +``` Available Commands: -* `add` Add a branch to the current stack. If no branch is given, add the current branch. -* `delete` Delete a gostacking. -* `list` List all stacks. -* `new` Create a new gostacking. -* `status` Get current stack. -* `switch` Change the current stack. Using name or index. -* `sync` Merge all branch in a stack into the current branch. -* `checkout` Checkout a branch from a stack. -* `remove` Remove a branch from the current stack. (Branch name or number) + add Add a branch to the current stack. If no branch is given, add the current branch. + checkout Checkout a branch from a stack. + completion Generate the autocompletion script for the specified shell + delete Delete a gostacking. + help Help about any command + list List all stacks. + new Create a new gostacking. + remove Remove a branch from the current stack. (Branch name or number) + status Get current stack. + switch Change the current stack. + sync Merge all branch in a stack into the current branch. +``` ## Example