summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorKali Kaneko <kali@leap.se>2013-08-26 15:25:04 +0200
committerKali Kaneko <kali@leap.se>2013-08-26 15:25:04 +0200
commit0b13f1eeef095e14beea065f9e6b97159180d37a (patch)
treec1f0c4e79d47cb420c142dca8a54627fbfbde128 /README.rst
parenta10924b0e2cf19feb673f23ff34707a663001335 (diff)
Add some notes about the package split.
* in description line * in readme * add each package crate icon and link.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst21
1 files changed, 19 insertions, 2 deletions
diff --git a/README.rst b/README.rst
index c2a33234..8fa966c2 100644
--- a/README.rst
+++ b/README.rst
@@ -2,11 +2,28 @@ Soledad
==================================================================
*Synchronization Of Locally Encrypted Data Among Devices*
-.. image:: https://pypip.in/v/leap.soledad/badge.png
- :target: https://crate.io/packages/leap.soledad
+Soledad is the part of LEAP that allows application data to be
+securely shared among devices. It provides, to other parts of the
+LEAP project, an API for data storage and sync.
This software is under development.
+There are currently three python packages maintained under this
+repository:
+
+**leap.soledad.common** common pieces.
+.. image:: https://pypip.in/v/leap.soledad.common/badge.png
+ :target: https://crate.io/packages/leap.soledad.common
+
+**leap.soledad.client** where the soledad client lives.
+.. image:: https://pypip.in/v/leap.soledad.client/badge.png
+ :target: https://crate.io/packages/leap.soledad.client
+
+**leap.soledad.server** oh surprise! bits needed for the soledad server.
+.. image:: https://pypip.in/v/leap.soledad.server/badge.png
+ :target: https://crate.io/packages/leap.soledad.server
+
+
Library dependencies
--------------------
* ``libsqlite3-dev``