aboutsummaryrefslogtreecommitdiff
path: root/acid.adoc
diff options
context:
space:
mode:
authorPřemysl Eric Janouch <p@janouch.name>2024-04-18 07:10:32 +0200
committerPřemysl Eric Janouch <p@janouch.name>2024-04-18 07:10:32 +0200
commitd632111c45683060e02fac828ad08f924e654d2d (patch)
tree25471915c4dc23a2d45f5ecd267e46569c57c1d2 /acid.adoc
parent4a23c47a924116b4ac8b8afb68ce1f372fa5c448 (diff)
downloadacid-d632111c45683060e02fac828ad08f924e654d2d.tar.gz
acid-d632111c45683060e02fac828ad08f924e654d2d.tar.xz
acid-d632111c45683060e02fac828ad08f924e654d2d.zip
Update documentationorigin/master
Diffstat (limited to 'acid.adoc')
-rw-r--r--acid.adoc13
1 files changed, 10 insertions, 3 deletions
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)