Update README.md

This commit is contained in:
Theis
2024-03-03 19:38:02 +01:00
committed by GitHub
parent 1e868d71c0
commit 84a58c53c6
+23 -1
View File
@@ -10,7 +10,29 @@ Currently tested in:
- [ ] Python - [ ] Python
# How to run # 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" <name1> [name2] [name3]...
$ cocommit "message" <name:email1> [name:email2] [name:email3]...
$ cocommit "message" <name:email1> <name1> [name:email2]
$ cocommit
*prints usage*
$ cocommit users
*prints list of users*
```
# Syntax for the author file # 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: 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: