apparently we need code here, addresses #2

1 files changed, 53 insertions, 0 deletions

diff --git a/globalist/README.md b/globalist/README.md
new file mode 100644
index 00000000..ba098cc7
--- /dev/null
+++ b/globalist/README.md
@@ -0,0 +1,53 @@
+# Globalist
+Idea: distributed githubless repository sharing. Yes, this is the official home ;-)
+
+Globalist is an attempt to ease the distribution of git repos, away from central points of failure.
+
+Globalist stands for "Global List" and aims at replacing any EtherPads of more than transient value.
+
+Globalist is also meant to evolve into an experimental distributed asynchronous wiki facility.
+
+Nodes can come and go, and network topology only depends on the peers entries in the nodes' config files. Changes that are merged by one's peers propagate by diffusion.
+
+## Usage
+
+Make a new directory and put this in the file ./repo.cfg (when creating a new repository instead of cloning from a peer, the list or indeed the repo.cfg file can remain empty)
+
+```
+[network]
+peers = <comma-separated list of onion domain names, with or without the suffix .onion>
+```
+
+For a public repository, no authentication is needed (option -X). In case authentication is used, prepend the secret as follows: somebody:secret@peeroniondomainname.onion
+
+For each shared repo, Globalist will create one .onion service. Note that it is possible to use either bare repos or not-bare repos.
+
+To clone a bare repo:
+
+```
+Globalist.py -bc ...
+```
+
+To pull once from a bare repo:
+
+```
+Globalist.py -bp
+```
+
+## To install locally
+
+```
+./setup.py install --user
+```
+
+or 
+
+```
+torsocks pip3 install -v -e .
+```
+
+## To do
+
+set default commit messages
+support signed commits
+push?