summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKali Kaneko <kali@leap.se>2013-09-04 23:26:54 +0200
committerKali Kaneko <kali@leap.se>2013-09-04 23:39:20 +0200
commite497e3bd99020f26dcfae3e0fa815179284a8050 (patch)
tree00e3018eba9ad359edb273f1b5569d695729251b
parent261de005c0a2ecbc8ef4a7771cfeb2a853cbc00d (diff)
Fix README link to rtd
-rw-r--r--README.rst19
1 files changed, 14 insertions, 5 deletions
diff --git a/README.rst b/README.rst
index 5d601578..f8308566 100644
--- a/README.rst
+++ b/README.rst
@@ -1,17 +1,26 @@
-The LEAP Encryption Access Project Client
-=========================================
-
+Bitmask
+=======
*your internet encryption toolkit*
.. image:: https://pypip.in/v/leap.bitmask/badge.png
:target: https://crate.io/packages/leap.bitmask
+**Bitmask** is the multiplatform desktop client for the services offered by
+`the LEAP Platform`_.
+It is written in python using `PySide`_ and licensed under the GPL3.
+Currently we distribute pre-compiled bundles for Linux and OSX, with Windows
+bundles following soon.
+
+.. _`PySide`: http://qt-project.org/wiki/PySide
+.. _`the LEAP Platform`: https://github.com/leapcode/leap_platform
+
+
Read the Docs!
------------------
The latest documentation is available at `Read The Docs`_.
-.. _`RTD`: http://bitmask.rtfd.org
+.. _`Read The Docs`: http://bitmask.rtfd.org
Dependencies
------------------
@@ -62,7 +71,7 @@ Hacking
The Bitmask git repository is available at::
- git://leap.se/bitmask
+ git://leap.se/leap_client
Some steps need to be run when setting a development environment for the first time.