From cab26bc223395ea4954c89a704a7a31b8cbd81aa Mon Sep 17 00:00:00 2001 From: drebs Date: Thu, 28 Sep 2017 15:06:21 -0300 Subject: [doc] add license information --- docs/index.rst | 28 +++++++++++++++++++--------- 1 file changed, 19 insertions(+), 9 deletions(-) (limited to 'docs') diff --git a/docs/index.rst b/docs/index.rst index 01ba04c8..0aa81dbf 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,14 +3,19 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Soledad: synchronization of locally encrypted data among devices +Soledad ================================================================ -Soledad consists of a client library and a server daemon that allow -applications to securely share a common state among devices. It is LEAP's -solution for synchronizing client-encrypted data among user's devices that -access a LEAP provider. +Synchronization of Locally Encrypted Data Among Devices. +What is Soledad? +---------------- + +Soledad is a client library and a server daemon that together allow +applications to securely share a common state among devices. It is `LEAP +`_'s solution for mail delivery and for synchronizing +client-encrypted data among a user's devices that access an account in a LEAP +provider. The local application is presented with a simple, document-centric searchable database API. Any data saved to the database by the application is @@ -18,12 +23,17 @@ client-encrypted, backed up in the cloud, and synchronized among a user's devices. Soledad is cross-platform, open source, scalable, and features a highly efficient synchronization algorithm. -The application is written in Python and the `source code -`_ is available and licensed as free software. -Both client and server are `distributed through pypi -`_, and `Debian packages +Soledad Client and Server are written in Python using `Twisted +`_. Source code is available at `0xacab +`_ and is licensed under the `GPLv3 +`_. Client and server are packaged +together and distributed in `pypi +`_. `Debian packages `_ are also provided for the server-side component. +Soledad documentation +--------------------- + .. toctree:: :maxdepth: 2 -- cgit v1.2.3