Make proper README files for each package.

[pithos] / snf-pithos-tools / README

diff --git a/snf-pithos-tools/README b/snf-pithos-tools/README
index 8b13789..a11655e 100644 (file)
--- a/snf-pithos-tools/README
+++ b/snf-pithos-tools/README
@@ -1 +1,30 @@
+README
+======
 
+Pithos is a file storage service, built by GRNET using Django (https://www.djangoproject.com/).
+Learn more about Pithos at: http://code.grnet.gr/projects/pithos
+
+Consult COPYRIGHT for licensing information.
+
+About Pithos tools
+------------------
+
+This packange contains the following utilities:
+
+==============  =============================
+pithos-sh       Pithos shell
+pithos-sync     Pithos synchronization client
+pithos-fs       Pithos FUSE implementation
+pithos-test     Pithos server tests
+==============  =============================
+
+Also, installs the pithos.tools.lib, which contains a python library that can be used to access Pithos and manage stored objects. All tools use the included lib.
+
+Connection options can be set via environmental variables:
+
+======================  =========================================================
+PITHOS_USER             Login user
+PITHOS_TOKEN            Login token
+PITHOS_URL              Pithos server (default: \https://plus.pithos.grnet.gr/v1)
+PITHOS_SYNC_CONTAINER   Container to sync with (default: pithos)
+======================  =========================================================