diff --git a/README.md b/README.md new file mode 100644 index 0000000..c51c0c6 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# git-su +switch between git users. + +is this original? not at all. this is my own take on it because i wanted my own syntax for the cli. + +## usage +note: git allows running commands formatted in `git-*` as `git *`, so you can also run this as `git su`. +``` +Usage: git-su + +Commands: + list list all profiles + use use a profile + add add a profile + remove remove a profile + current show current git user + help Print this message or the help of the given subcommand(s) + +Options: + -h, --help Print help + -V, --version Print version +``` + +## installation + +there is currently no automated installation. simply build the program and place the resulting executable in your path. + +## building + +build using `just`. see available recipes by running `just` or `just --list`.