From 84a58c53c6c2b7a2299c103fad288b2934b0a4b7 Mon Sep 17 00:00:00 2001 From: Theis <112340858+Slug-Boi@users.noreply.github.com> Date: Sun, 3 Mar 2024 19:38:02 +0100 Subject: [PATCH] Update README.md --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9e0a099..2aaa99d 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,29 @@ Currently tested in: - [ ] Python # How to run -*Coming soon* +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: +[Bash Guide](https://linuxize.com/post/how-to-create-bash-aliases/) +*^please note if you use another shell than bash you will need to look up how to do it in that shell^* +[Powershell Guide](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/set-alias?view=powershell-7.4) + +Once you've created an alias for the program you need to set an env variable (authors_file) in your shell. This should be the path pointing to your authors.txt file + +you can now run it using the alias shorthand you assigned it to +## Usage: +```zsh +$ cocommit "message" [name2] [name3]... + +$ cocommit "message" [name:email2] [name:email3]... + +$ cocommit "message" [name:email2] + +$ cocommit +*prints usage* + +$ cocommit users +*prints list of users* +``` # Syntax for the author file The syntax for the author file can be found at the top of the template file included in the repo. It should look like this: