From 472dbbe96d7cc13fe8dbcb5b715cbc02cd52fc22 Mon Sep 17 00:00:00 2001 From: Slug-Boi Date: Mon, 25 Nov 2024 20:23:30 +0100 Subject: [PATCH] docs: add go install instructions to readme --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bd30b24..23dd833 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,12 @@ ## Install: -*Insert blerb about go install if it works* +It should be possible to install the program using the go install command: +``` +$ go install github.com/Slug-Boi/cocommit +``` +You will more than likely have to add the binary to your PATH after the fact if your go bin directory is not in your PATH already. Or you can create an alias to it using the instructions below. + Download the binary for your OS on the [release page](https://github.com/Slug-Boi/cocommit/releases) Once downloaded you need to create an alias for your shell guides found below: