From 9c98b98ccdc2c3f4addcfacdd33d3330e75a955f Mon Sep 17 00:00:00 2001 From: Callum Dickinson Date: Wed, 6 Dec 2023 08:09:32 +1300 Subject: [PATCH] Add README documentation --- README.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2289e22..d03cfb1 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,23 @@ -# buildarr-installer -Windows installer for Buildarr and bundled plugins +# Buildarr Installer + +![GitHub release (with filter)](https://img.shields.io/github/v/release/buildarr/buildarr-installer) ![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/buildarr/buildarr-installer/test-build.yml) + +This repository builds and hosts Windows installers for [Buildarr](https://buildarr.github.io), based on the [Nullsoft Scriptable Install System](https://en.wikipedia.org/wiki/Nullsoft_Scriptable_Install_System). + +## Installing Buildarr + +Download the latest version of the installer from the [Buildarr Installer releases page](https://github.com/buildarr/buildarr-installer/releases), and follow the installation instructions as documented on the Buildarr website. + +## Development + +### Building an installer + +Installer builds are automatically tested using GitHub Actions for pull requests. Check the build artifacts for the workflow run to download the installer build files, which includes the completed installer file. + +[Workflow runs can be manually executed](https://github.com/buildarr/buildarr-installer/actions/workflows/test-build.yml), if builds against standard branches are required. + +## Releasing a new version + +Create a new release manually, as normal. No additional actions are required. + +When a new version of the installer is released, GitHub Actions automatically builds the installer and adds it to the release.