From 553bb4289f957cc7ef4bf4b424f85da46fd6f2c8 Mon Sep 17 00:00:00 2001 From: Marcelo Velasquez Date: Tue, 15 Nov 2022 18:15:39 -0500 Subject: [PATCH] Explain the usage in the readme --- README.md | 54 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 53 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index aa30f54..84d3267 100644 --- a/README.md +++ b/README.md @@ -14,4 +14,56 @@ curl https://raw.githubusercontent.com/itmarck/deploy.sh/main/install.sh | bash ## Usage -TBD +``` +Usage: deploy [OPTION]... [REPOSITORY]... +``` + +### Guide to use + +Basic instructions to start using the command. + +```bash +# List available repositories +deploy + +# Add a repository where REPOSITORY is the path to the repository +deploy --add REPOSITORY + +# Run a deployment file by repository name +# To specify the deployment file, use the --file option +deploy REPOSITORY + +# Remove a repository by name +deploy --remove REPOSITORY + +# Remove all repositories +deploy --clean + +# Show command version +deploy --version + +# Show command help +deploy --help +``` + +### Flags + +Available flags to use with the command. + +``` + -a, --add Add REPOSITORY to the list + -c, --clean Clean all repositories + -f, --file Specify the deployment filename (default: deploy.sh) + -r, --remove Remove the REPOSITORY + -v, --verbose Print verbose output + --help Show this help information + --version Show command version +``` + +## Updating + +The installation process use a detailed copy of the repository and it doesn't override the data storaged. So you can safely update by running the `install.sh` file again or by running the installation command specified above. + +## Uninstalling + +To uninstall the command, just remove the `deploy` file and the `.deploy` folder from `/usr/local/bin` folder.