diff --git a/README.md b/README.md index c476a7c..f2ab0e3 100644 --- a/README.md +++ b/README.md @@ -18,9 +18,12 @@ brew tap michael/formula https://git.housh.dev/michael/homebrew-formula brew install michael/formula/hpa ``` +<<<<<<< HEAD Installation on platforms other than `macOS` are currently being worked on, along with support for running in a `docker` container. +======= +>>>>>>> 2944a12 (feat: Adds readme and license files) ### Ensuring dependencies are installed. This application requires some dependencies to be installed on your system, you can install the @@ -41,9 +44,12 @@ It will also download an ansible-playbook that is used to generate output files, repositories, and encrypt / decrypt variable files. The playbook get's installed to `~/.local/share/hpa/playbook`. +<<<<<<< HEAD > NOTE: All commands accept a `--help` option which will display the arguments and options a command > can use, along with example usage of the commands. +======= +>>>>>>> 2944a12 (feat: Adds readme and license files) ### Configure the application. When you first download the application you can setup the configuration file for your use case. @@ -96,7 +102,11 @@ hpa create --template-dir ~/projects/my-template ~/consults/my-first-consult Or if your configuration has `directory` set in the `template` section. ```bash +<<<<<<< HEAD hpa create --use-local-template ~/consults/my-first-consult +======= +hpa create -l ~/consults/my-first-consult +>>>>>>> 2944a12 (feat: Adds readme and license files) ``` ## Generating output files. @@ -147,6 +157,7 @@ like to generate output for. hpa build --project-directory ~/consults/my-first-consult ``` +<<<<<<< HEAD ## Some General Usage Notes: There is often a lot of output to the console when running commands, which can be problematic if you @@ -157,6 +168,8 @@ Along the similar line, if you would like to increase the logging output then al `-v | --verbose` that will increase the logging output. This can be passed multiple times, so for the highest log output you can do `-vvv`. +======= +>>>>>>> 2944a12 (feat: Adds readme and license files) ## Uninstalling You can uninstall the application using: