From 1ce25c93f3b5716da2bf55adce1d439f5cf3b84a Mon Sep 17 00:00:00 2001 From: Michael Housh Date: Wed, 18 Dec 2024 14:47:32 -0500 Subject: [PATCH] feat: More readme, also removes ci from dev branch and only runs for pulls and pushes to main. --- .gitea/workflows/ci.yaml | 2 +- README.md | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/.gitea/workflows/ci.yaml b/.gitea/workflows/ci.yaml index ddf9963..0911e9a 100644 --- a/.gitea/workflows/ci.yaml +++ b/.gitea/workflows/ci.yaml @@ -2,7 +2,7 @@ name: CI on: push: - branches: ["main", "dev"] + branches: ["main"] pull_request: jobs: diff --git a/README.md b/README.md index aef7127..df6b3ea 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,9 @@ 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`. +> 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. + ### Configure the application. When you first download the application you can setup the configuration file for your use case.