From d632111c45683060e02fac828ad08f924e654d2d Mon Sep 17 00:00:00 2001 From: Přemysl Eric Janouch Date: Thu, 18 Apr 2024 07:10:32 +0200 Subject: Update documentation --- acid.adoc | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) (limited to 'acid.adoc') diff --git a/acid.adoc b/acid.adoc index 6775d52..ff5d69b 100644 --- a/acid.adoc +++ b/acid.adoc @@ -15,11 +15,14 @@ Synopsis Description ----------- *acid* run without command arguments will start an HTTP server that creates -and executes tasks upon receiving push notifications from a Gitea instance, -according to the passed configuration file. +and executes tasks against *git*(1) commits from a particular Gitea instance, +in accordance with the passed configuration file. When a command is passed, *acid* will relay it to that running instance -as an RPC call. +of itself as an RPC call. + +Tasks can be triggered to run either upon receiving Gitea push events +on the */push* endpoint, and/or using the RPC commands. Options ------- @@ -85,3 +88,7 @@ Reporting bugs -------------- Use https://git.janouch.name/p/acid to report bugs, request features, or submit pull requests. + +See also +-------- +*git*(1), *sh*(1) -- cgit v1.2.3-70-g09d2