summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorIvan Alejandro <ivanalejandro0@gmail.com>2013-09-04 18:39:14 -0300
committerIvan Alejandro <ivanalejandro0@gmail.com>2013-09-04 18:39:14 -0300
commit2bcff2cf5154af5bf129ced066a014925a5eac0b (patch)
tree00e3018eba9ad359edb273f1b5569d695729251b /README.rst
parent9e47e7695e25802f7f0e33deacb940ce72720486 (diff)
parente497e3bd99020f26dcfae3e0fa815179284a8050 (diff)
Merge remote-tracking branch 'kali/feature/update-docs-to-0.3.2' into develop
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst26
1 files changed, 21 insertions, 5 deletions
diff --git a/README.rst b/README.rst
index 7c415663..f8308566 100644
--- a/README.rst
+++ b/README.rst
@@ -1,11 +1,27 @@
-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`_.
+
+.. _`Read The Docs`: http://bitmask.rtfd.org
+
Dependencies
------------------
@@ -55,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.
@@ -101,7 +117,7 @@ which the first time should automagically install all the needed dependencies in
License
=======
-.. image:: https://raw.github.com/leapcode/bitmask/develop/docs/user/gpl.png
+.. image:: https://raw.github.com/leapcode/leap_client/develop/docs/user/gpl.png
Bitmask is released under the terms of the `GNU GPL version 3`_ or later.