summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2b902f6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+# it: zero-g git
+
+_it_ aims to augment git with primitives to build integrated, cryptographically
+verifiable collaboration workflows around source code. It maintains the
+distributed property of git, not requiring a central server. _it_ is transport
+agnostic, and permits data dissemination in client-server, federated, as well as
+peer-to-peer network topologies.
+
+
+## Status
+
+The [spec](./Documentation/spec.adoc) is thought of as being stable, in the
+sense that any amendments will consider backwards compatibility.
+
+The source code in this repository has been developed exploratively, in order to
+validate and refine the ideas laid out in above document. As such, it is
+incomplete, may occasionally malfunction, and does not yet provide the fine bone
+porcelain rendering it usable in anger. It's a prototype, if you wish.
+
+_it_ is actively developed on a volunteer basis.
+
+
+## Usage
+
+The _it_ implementation is written in Rust and can be installed from source
+using [cargo](https://doc.rust-lang.org/cargo/):
+
+ cargo install --git https://git.eagain.io/it
+
+To get an overview, see the [getting started](./Documentation/getting-started.adoc)
+document.
+
+
+## License
+
+GPL-2.0, see [COPYING](./COPYING)