summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorDaniel Silverstone <dsilvers@digital-scurf.org>2017-01-14 19:19:49 +0000
committerDaniel Silverstone <dsilvers@digital-scurf.org>2017-01-14 19:19:49 +0000
commit7314eaaed5d1ab51b5827ab1eca305a985a02cea (patch)
tree4de796be7ff579c2ebe00e255613c688e0c6d765 /README
parent081f601ebe248be58c672454b3d8b89c55758e1b (diff)
downloadgitano-7314eaaed5d1ab51b5827ab1eca305a985a02cea.tar.gz
Update README
Diffstat (limited to 'README')
-rw-r--r--README36
1 files changed, 31 insertions, 5 deletions
diff --git a/README b/README
index 2d2a128..7c30bf8 100644
--- a/README
+++ b/README
@@ -1,14 +1,18 @@
# Gitano -- Git with Augmented Network Operation
-## Development tracked on Trello:
-
-https://trello.com/board/gitano/4f9fee3d26a8c8e8340941a4
-
## Website
-Gitano has a website at https://www.gitano.org.uk/ and a gitweb at
+Gitano has a website at https://www.gitano.org.uk/ and a cgit instance at
https://git.gitano.org.uk/ -- Enjoy them.
+In addition, further documentation and examples can be found on the Gitano
+wiki at https://wiki.gitano.org.uk/
+
+## Development is tracked on a Kanban board
+
+Gitano's development is tracked on a Kanban board which can be found linked
+from the sidebar of https://www.gitano.org.uk/
+
## Dependencies
Gitano depends on [lua-scrypt], [Luxio], [Lace], [Supple], [Gall], [Clod], and
@@ -32,3 +36,25 @@ on your PATH.
If you wish to use password authentication
then the `htpasswd` binary must be present in your PATH.
In debian this is provided by `apache2-utils`.
+
+## Stability guarantees
+
+* **Rulesets**: During the v1.x series of releases, Gitano rulesets will
+continue to work and while additional variables or predicates may be added,
+nothing will be removed or renamed entirely unless failing to do so would
+constitute a security risk. This guarantee is not provided for a move from
+v1.x to v2.x. or from any v1.n to v.(n-1).
+* **Commands**: The command interface of Gitano is meant for humans to interact
+with, and there is no stability of the command interface defined for the v1.x
+series of Gitano.
+* **Hooks**: The interface between Gitano and hooks is guaranteed to only
+increase in functionality through the v1.x series unless failing to remove or
+incompatibly alter functionality would constitute a security risk.
+* **Plugins**: The plugin interface is considered entirely unstable at this
+time and there is no guarantee that the current interfaces will remain stable
+through the v1.x series. Any rules, commands, hooks, etc, defined in published
+plugins distributed with Gitano will be subject to the same constraints as
+stated above.
+* **Lua API**: The API of the Gitano Lua modules is an internal implementation
+detail for the purposes of the v1.x series and should not be relied upon to
+remain stable between any two releases in the series.