summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--lib/gall.lua6
1 files changed, 6 insertions, 0 deletions
diff --git a/lib/gall.lua b/lib/gall.lua
index 52f04b2..a35ae51 100644
--- a/lib/gall.lua
+++ b/lib/gall.lua
@@ -14,6 +14,12 @@
-- will call out to the Git binary where reimplementing things in-process would
-- be awkward or error-prone.
--
+-- **NOTE**: `gall` is not trying to be a complete API onto Git at this time.
+-- Instead it is aiming to provide a fairly complete read-only interface to
+-- enough of a Git repository to facilitate a Git server's ACLs and also enough
+-- of a write-interface to ensure that such a server can store its config etc
+-- in a Git repository.
+--
-- @module gall
local API_VERSION = 0