add readme and changelog to long-description

reformat changelog in .rst

5 files changed, 400 insertions, 390 deletions

diff --git a/CHANGELOG b/CHANGELOG
deleted file mode 100644
index 25e90051..00000000
--- a/CHANGELOG
+++ /dev/null
@@ -1,369 +0,0 @@
-0.3.5 Oct 18 -- the "I can stand on one foot" release:
-  o In case of Soledad failure, display to the user that there was a
-    problem. Closes #4025.
-  o Widget squashing problem in wizard checking a new provider. Closes
-    #4058.
-  o Remember last domain used to login. Closes #4116.
-  o Display first run wizard, regardless of pinned providers. Closes
-    #4143.
-  o Show EIP status 'ON' in the systray tooltip when is
-    connected. Related to #3998.
-  o Catch u1db errors during soledad initialization.
-  o Disable --danger flag on release versions. Closes #4124.
-  o Display mail status in the tray icon as an enabled item. Fixes
-    #4036.
-  o Only show N unread Emails when N > 0. Fixes #4098.
-  o Hide login error message when the user interacts with the widgets
-    to fix the potential problem. Fixes #4022.
-  o Add call to `make` to the bootstrap script.
-  o Improve GUI based on QA rounds. Fixes #4041 and #4042.
-  o Increase the amount of retries for the authentication request
-    session. Fixes #4037.
-  o Rename EIP to Encrypted Internet in its preference panel. Fixes
-    #4057.
-  o Disable stdout redirection on Windows for the time being since it
-    breaks the bundle.
-  o Default UP_SCRIPT and DOWN_SCRIPT to None and only add that
-    parameter to the vpn command if not None.
-  o Look for gpg on windows with the .exe extension.
-  o Change the Util menu to be named File in OSX. Fixes #4039.
-  o Show more context information in the logs. Closes #3923.
-  o Automate internationalization process, create project file
-    dynamically on make. Closes #3925.
-  o Add support for running lxde polkit agent. Closes #4028.
-  o Added Vietnamese and English (United Kingdom) translations.
-  o Implements openvpn observer. Closes: #3901
-  o Reconnect EIP if network down. Closes #3790
-  o Reconnect if tls-restart. Closes: #3262
-
-0.3.4 Oct 4 -- the "look at my new makeup" release:
-  o Fixes a bug where you cannot login to a different provider once
-    you logged in to another one. Fixes #3695.
-  o Resets the session for every login attempt. Related to #3695.
-  o Avoid error message if --version flag is used. Closes #3914.
-  o Fix a bug in which failing to authenticate properly left
-    connection in an unconsistent state. Closes: #3926
-  o Avoids errors due to the EIP switch button and action being
-    enabled when we do not have a configured provider. Closes: #3927
-  o Add more verbose error handling during key generation and syncing.
-    Helps diagnose: #3985; Addresses in part: #3965
-  o Choose one gnupg binary path that is also not a symlink. Closes
-    #3999.
-  o Refactor vpn launchers, reuse code, improve implementations,
-    update documentation. Closes #2858.
-  o Add preferences option to enable/disable the automatic start of
-    EIP and selection of the EIP provider to auto start. Closes #3631.
-  o Force cleanlooks style for kde only if the app is running from
-    bundle. Closes #3981.
-  o Add a dropdown for known providers in the wizard. Closes #3995.
-  o Separate pinned providers from user configures ones. Closes #3996.
-  o Improve error handling during soledad bootstrap. Closes: #3965.
-    Affects: #3619, #3867, #3966
-  o Implement new UI design. Closes #3973.
-  o Make the initial provider cert verifications against our modified
-    CA-bundle (includes ca-cert certificates, for now). Closes: #3850
-  o Use token header for authenticated requests. Closes #3910.
-  o Do not distinguish between different possible authentication
-    errors. Fixes #3859.
-  o Do not start Soledad if Mail is not enabled. Fixes #3989.
-  o Allow window minization on OSX. Fixes #3932.
-  o Properly stop the smtp daemon. Fixes #3873.
-
-0.3.3 Sep 20 -- "the calm after the tempest" release:
-  o Remove execution bits in text files in bundle. Closes #3617.
-  o Use generic bad username/password message instead of specific ones when
-    the user uses incorrect data during login. Closes #3656.
-  o Fix LoggerWindow saving more than one line return per line in the logs
-    file. Closes #3714.
-  o Fix keyring imports so we do not get import errors. Closes: #3759
-  o Catch logout problem, display a user message and allow log back in after a
-    successful logout if there was a logout error before. Closes #3774.
-  o Fix path prefix helper for the bundle and add regresion tests. Closes #3778.
-  o Prevent dialogs closing the app when it has been minimized to the tray. Closes #3791.
-  o Do not try to install resolv-update globally. Closes: #3803
-  o Inconsistent hide/show main window from tray action. Closes #3821.
-  o Allow SMTP to start even when provider does not offer EIP. Closes: #3847
-  o Fix username case problem at register/login. Closes #3857.
-  o Catch IndexError on `first` utility.
-  o Update git repo name in docs. Closes: #3417
-  o Move STANDALONE flag to a module and unify get_path_prefix queries.
-    Closes #3636.
-  o Display the Encrypted Internet and Encrypted Email status in the systray
-    tooltip. Closes #3758.
-  o Tasktray menu changes, closes #3792.
-    - Remove the provider domain item (e.g. bitmask.net).
-    - Rename the EIP status menu items to be more descriptive.
-    - Change the EIP status menu items from disabled menu items
-      to submenus with children.
-    - Move the EIP action menu items under the EIP status submenu tree.
-  o Adds --version flag. Closes: #3816
-  o Refactors EIPConnection to use LEAPConnection state machine. Closes: #3900
-  o Include resource files and ui in the distrubution tarball. Closes: #3825
-
-0.3.2 Sep 6 -- the "no crashes or anything" release:
-  o Fix up script in non-bundle linuces. Closes: #3450
-  o Logout stops imap and smtp services. Closes: #3553
-  o Properly daemonize polkit-gnome-authentication-agent. Closes: #3554
-  o Set appropiate error on login cancel. Closes #3582.
-  o Fix gateway selection problem. Closes 3595.
-  o Fix typo in wizard: stablish -> establish. Closes #3615.
-  o Display Encrypted Mail instead of mx in wizard. Closes #3657.
-  o Fix save logs to file dialog freezing. Closes #3675.
-  o Complain if setup.py is run with python3. Closes: #3711
-  o Enable preferences option in systray. Closes #3717.
-  o Make soledad emit failed signal for all kinds of socket error.
-  o Allow to selectively silence logs from different leap components. Closes: #3504
-  o Add option to select gateway manually in the preferences panel. Closes #3505.
-  o Add preferences option to select the enabled services of a provider. Closes #3534.
-  o Refactor basic password checks. Closes #3552.
-  o Use dirspec instead of plain xdg. Closes #3574.
-  o Remove last page from wizard. Closes #3616.
-  o Display encrypted mail status in the tray. Closes #3659.
-
-0.3.1 Aug 23:
-  o Replace wizard images with the rainbow mask. Closes #3425.
-  o Update leap.common minimum version needed.
-  o Set the standalone flag before it's being used. Fixes #3426.
-  o Stop the twisted reactor adding the stop call to the call chain
-    instead of stopping it directly. Fixes #3406.
-  o Allow soledad initialization to retry if it times out. Closes:
-    #3413
-  o Activate window when setting it visible. Also display Hide/Show
-    message in the tray icon taking into account the window
-    activation. Fixes #3433.
-  o Do not start IMAP daemon if mail was not selected among the
-    services. Fixes #3435.
-  o Reword RECONNECTING state of openvpn. Fixes #3429.
-  o Improve OpenVPN detection by searching for a specific leap-only
-    string in the command line. This makes it possible to run other
-    VPN instances while also using EIP. Fixes #3268 and #3364.
-  o OSX: Check for the tun.kext existence in /Library/Extensions
-    instead of /System/Library/Extensions. Fixes #3271.
-  o Use DELETE /1/logout to properly logout. Fixes #3510.
-  o Make the poll interval bigger to improve openvpn's internal
-    behavior. If it gets queried too many times per second, it's
-    behavior won't be good. Fixes #3430.
-  o Transforms usernames to lower case before they are used in the
-    registration and authentication. Closes #3541.
-  o Add filter option to the logger window. Closes #3407.
-  o Add a preference panel that lets you change your password. Closes
-    #3500 #2798 #3533.
-  o Move all client code into its own namespace
-    (leap.bitmask). Closes: #2959
-  o Make mail fetch interval in imap service configurable via
-    environment variable. Closes: #3409
-  o Update to new soledad package scheme (common, client and
-    server). Closes #3487.
-  o Fetch incoming mail when mail client logs in. Closes: #3525
-  o Add first draft of the UI for Encrypted Mail. Closes #3499.
-
-0.3.0 Aug 9:
-  o Add missing scripts does not stop if a command fails, also warns
-    the user if there was an error. Closes #3294.
-  o Replace 'Sign Out' with 'Log Out' and 'User' with
-    'Username'. Closes #3319.
-  o Verify cacert existence before using it. Closes bug #3362.
-  o Properly handle login failures. Closes bug #3401.
-  o Bugfix, avoid getting negative rates. Closes #3274.
-  o Raise window when setting it as visible. Fixes #3374
-  o Fail gracefully when the events port 8090 is in use by something
-    else. Fixes #3276.
-  o Validate the username in the login form against the same regexp as
-    the wizard registration form. Fixes #3214.
-  o Update text from the tray menu based on the visibility of the
-    window. Fixes #3400.
-  o Add check for outdated polkit file. Closes #3209.
-  o Add support for multiple schemas so we can support multiples api
-    versions. Closes #3310.
-  o Rebrand the client to be named Bitmask. Feature #3313.
-  o Add cancel button to login. Closes #3318.
-  o Add multiple schema support for SMTP. Closes #3403.
-  o Add multiple schema support for Soledad. Closes #3404.
-  o Update Transifex project name and translators'
-    documentation. Closes #3418.
-  o Add check for tuntap kext before launching openvpn. Closes: #2906
-  o Accept flag for changing openvpn verbosity in logs. Closes: #3305
-  o Add imap service to the client. Closes: #2579
-  o Add pyside-uic support inside the virtualenv. This way it won't
-    fail to 'make' if the virtualenv is activated. Closes #3411.
-  o Reintegrate SMTP relay module. Closes #3375
-  o Reintegrate Soledad into the client. Closes #3307.
-  o Support bundled gpg. Related to #3397.
-  o Set the default port for SMTP to be 2013.
-  o Display a more generic error message in the main window, and leave
-    the detailed one for the log. Closes #3373.
-
-0.2.4 Jul 26:
-  o Use the provider CA cert for every request once we have it
-    bootstrapped (TOFU). Closes #3227.
-  o Make calls to leap.common.events asynchronous. Closes #2937.
-  o Always logout when closing the app if the user previously signed
-    in. Fixes #3245.
-  o Make sure the domain field in provider.json is escaped to avoid
-    potential problems. Fixes #3244.
-  o Fix incorrect handling of locks in Windows so that stalled locks
-    do not avoid raising the first instance of the app. Closes: #2910
-  o Use traffic rates instead of totals. Closes #2913
-  o Allow to alternate between rates and total throughput for the
-    virtual interface. Closes: #3232
-  o Reset rates/totals when terminating connection. Closes #3249
-  o Fix a bug in the displayed magnitude for the up/down traffic rates
-    and totals.
-  o Force Cleanlooks style if we are running in a KDE environment, so
-    that it doesn't load potentially incompatible Qt libs. Fixes
-    #3194.
-  o Wrap long login status messages to 40 characters. Fixes #3124
-  o Workaround a segmentation fault when emitting a signal with its
-    last parameter being None. Fixes #3083.
-  o Added IS_RELEASE_VERSION flag that allows us to use code only in
-    develop versions. Closes #3224.
-  o Try to terminate already running openvpn instances. Closes #2916
-  o Linux: Dynamically generate policy file for polkit. Closes #3208
-  o Workaround some OpenVPN problems with priviledge dropping and
-    routing. Fixes #3178 #3135 #3207 #3203
-
-0.2.3 Jul 12:
-  o Adapt code to Soledad 0.2.1 api.
-  o Fix Main Window briefly display before the wizard on first
-    start. Closes Bug #2954.
-  o Bugfix: Remember should not be automatically set to
-    checked. Closes #2955.
-  o Bugfix: reload config if switching to a different provider. Closes
-    #3067.
-  o Bugfix: logger window's toggle button reflects window
-    state. Closes #3152.
-  o Set timeout for requests to 10 seconds globally, configurable from
-    leap.util.constants. Fixes #2878.
-  o Bugfix: display error message on registration problem. Closes
-    #3039.
-  o Make wizard use the main event loop, ensuring clean termination.
-  o Use cocoasudo for installing missing updown scripts.
-  o Bugfix: Systray Turn ON action fails because is not correctly
-    enabled/disabled. Closes #3125.
-  o Bugfix: wrong systray icon on startup. Closes #3147.
-  o Bugfix: parse line return in the logger window. Closes #3151.
-  o Do not log user data on registration. Fixes #3168.
-  o Add --log-append eip.log to windows EIP launcher options to save
-    the logs in case of any problems. Fixes #2054.
-  o OSX: Make the install_path relative to the launcher path instead
-    of absolute.
-  o OSX: Fix icon display in cocoasudo.
-  o OSX: Raise window when showing if running on OSX.
-  o Bugfix: EIP status button moved to status panel.
-  o Check if there is no gateway to use and display correct
-    message. Close #2921.
-  o Reorder tray icons according new design. Closes #2919.
-  o Redirect stdout/stderr and twisted log to the logger. Closes
-    #3134.
-  o Improve LoggerWindow colors for easier debugging.
-  o Move the key manager to its own repository/package.
-
-0.2.2 Jun 28:
-  o Add support for the kde polkit daemon
-  o Handle 'Incorrect Password' exception (keyring)
-  o Select the configured domain in the providers combo box. Closes
-    #2693.
-  o Remember provider along with the username and password. Closes
-    #2755.
-  o Close the app on rejected wizard. Closes bug #2905.
-  o Only use the Keyring when it's using a known good backend. Closes
-    #2960
-  o Update implementation and semantics of the supported and available
-    services by a provider. Closes bug #3032.
-  o Only show the question mark for a check being done if the previous
-    one passed. Fixes #2569.
-  o Fix main client window not restoring after minimized into
-    systray. Closes #2574
-  o Set EIP different status icons depending on OS. Closes #2643.
-  o Reimplement openvpn invocation to use twisted ProcessProtocol
-  o Add runtime requirements checker, verifies that the requirements
-    are installed and in its correct versions. Closes #2563
-  o Add centraliced logging facility, log history in a window. Closes
-    #2566
-  o Improve wizard, hide registration widgets (labels, inputs, button)
-    and only display a message. Closes #2694
-  o Clarify labels through the app (use of EIP)
-  o Check if the provider api version is supported. Closes feature
-    #2774.
-  o Autoselect VPN gateway based on timezone. Closes #2790.
-  o Disable vpn disconnect on logout. Closes #2795.
-  o Improve gateway selector based on timezone. It allows to use
-    multiple gateways in openvpn for redundancy. Closes #2894.
-  o Use cocoasudo in place of osascript for osx privilege escalation
-    during openvpn launch.
-  o Clicking in the tray icon will always show the context menu
-    instead of activating the window under certain
-    circumstances. Closes #2788
-  o Autostart EIP whenever possible. Closes #2815
-  o Update test suite, run_scripts and requirements to run smoothly
-    with buildbot.
-  o Add a copy of the processed requirements to util/
-  o Display the default provider configured in the systray menu. Close
-    #2813
-  o Make the login steps be a chain of defers in order to be able to
-    have more cancel points for the whole procedure. Closes #2571
-  o Linux: check for up/down scripts and policy files and ask user for
-    permission to install them in a root-writeable location. Used from
-    within bundle or for broken installations.
-  o Integrate SMTP-Relay into the client.
-  o Integrate Soledad and KeyManager.
-  o Move the KeyManager from leap.common to leap-client.
-  o Only use one systray icon, repesenting the status for EIP. Closes
-    #2762
-  o Properly set the binary manifest to the windows openvpn
-    binary. Closes #203
-  o OSX: Add dialog with suggestion to install up/down scripts if
-    these not found. Closes: #1264, #2759, #2249
-  o Workaround for PySide breaking with multiple inheritance. Closes
-    #2827
-  o Refactor login to its own widget and remove Utils menu. Closes
-    #2789
-  o Refactor the status bits out of the MainWindow to its own
-    StatusPanelWidget. Closes #2792
-  o Save the default provider to be used for autostart EIP as
-    DefaultProvider in leap.conf. Closes #2793
-  o Cleanly terminate openvpn process, sending SIGTERM and SIGKILL
-    after a while. Closes #2753
-  o Use twisted's deferToThread and Deferreds to handle parallel tasks
-  o Use a qt4 reactor for twisted, for launching leap twisted
-    services.
-
-0.2.1 May 15:
-  o Rewrite most of the client based on the insight gained so far.
-  o Deselecting the remember checkbox makes the app not populate
-    user/password values on the login widget. Closes #2059
-  o Rewording of setup steps in wizard, to make them more meaningful
-    to the non-technical user. Closes #2061
-  o Fix typo in wizard.
-  o Fix multiple drawing of services if going back.
-  o Make registration errors show in red.
-  o Add a warning if EIP service needs admin password. Addresses part
-    of #2062
-  o Make traffic indicators display fixed precision. Closes #2114
-  o Do not hide the application if the user right clicked the system
-    tray icon.
-  o Sanitize network-fetched content that is used to build openvpn
-    command.
-  o Avoids multiple instances of leap-client. Each new one just raises
-    the existing instance and quits.
-  o Use dark eip icons os osx. Closes #2130
-  o Moves BaseConfig to leap.common.config. Closes #2164
-  o Add handling for ASSIGN_IP state from OpenVPN in the mainwindow.
-  o Emit events notifying of the session_id and uid after
-    authentication so other services can make use of it. Closes #1957
-  o Working packaging workflow with rewritten client, using
-    pyinstaller and platypus.
-  o Remove network checks temporarily until we find a good way of
-    doing it, and a good way to deal with them.
-  o Saves the token to allow token authenticated queries.
-  o Turn "leap" into namespace package, move common files to
-    leap_common package that can be shared by other LEAP projects.
-  o Support standalone configurations for distribution in thumbdrives
-    and the like.
-  o Add support for requests < 1.0.0
-  o Tests infrastructure, and tests for crypto/srpauth and crypto/srpregister.
-  o Documentation updated for 0.2.1 release.
-  o Docstrings style changed to fit sphinx autodoc format.
-  o Add a simple UI to notify of pending updates.
-  o Add Windows support.
-  o Try to install TAP driver on Windows if no tap device is preset.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
new file mode 100644
index 00000000..e9740e4a
--- /dev/null
+++ b/CHANGELOG.rst
@@ -0,0 +1,394 @@
+.. :changelog::
+
+History
+-------
+
+0.3.5 Oct 18 -- the "I can stand on one foot" release:
+++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+- In case of Soledad failure, display to the user that there was a
+  problem. Closes #4025.
+- Widget squashing problem in wizard checking a new provider. Closes
+  #4058.
+- Remember last domain used to login. Closes #4116.
+- Display first run wizard, regardless of pinned providers. Closes
+  #4143.
+- Show EIP status 'ON' in the systray tooltip when is
+  connected. Related to #3998.
+- Catch u1db errors during soledad initialization.
+- Disable --danger flag on release versions. Closes #4124.
+- Display mail status in the tray icon as an enabled item. Fixes
+  #4036.
+- Only show N unread Emails when N > 0. Fixes #4098.
+- Hide login error message when the user interacts with the widgets
+  to fix the potential problem. Fixes #4022.
+- Add call to `make` to the bootstrap script.
+- Improve GUI based on QA rounds. Fixes #4041 and #4042.
+- Increase the amount of retries for the authentication request
+  session. Fixes #4037.
+- Rename EIP to Encrypted Internet in its preference panel. Fixes
+  #4057.
+- Disable stdout redirection on Windows for the time being since it
+  breaks the bundle.
+- Default UP_SCRIPT and DOWN_SCRIPT to None and only add that
+  parameter to the vpn command if not None.
+- Look for gpg on windows with the .exe extension.
+- Change the Util menu to be named File in OSX. Fixes #4039.
+- Show more context information in the logs. Closes #3923.
+- Automate internationalization process, create project file
+  dynamically on make. Closes #3925.
+- Add support for running lxde polkit agent. Closes #4028.
+- Added Vietnamese and English (United Kingdom) translations.
+- Implements openvpn observer. Closes: #3901
+- Reconnect EIP if network down. Closes #3790
+- Reconnect if tls-restart. Closes: #3262
+
+0.3.4 Oct 4 -- the "look at my new makeup" release:
++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+- Fixes a bug where you cannot login to a different provider once
+  you logged in to another one. Fixes #3695.
+- Resets the session for every login attempt. Related to #3695.
+- Avoid error message if --version flag is used. Closes #3914.
+- Fix a bug in which failing to authenticate properly left
+  connection in an unconsistent state. Closes: #3926
+- Avoids errors due to the EIP switch button and action being
+  enabled when we do not have a configured provider. Closes: #3927
+- Add more verbose error handling during key generation and syncing.
+  Helps diagnose: #3985; Addresses in part: #3965
+- Choose one gnupg binary path that is also not a symlink. Closes
+  #3999.
+- Refactor vpn launchers, reuse code, improve implementations,
+  update documentation. Closes #2858.
+- Add preferences option to enable/disable the automatic start of
+  EIP and selection of the EIP provider to auto start. Closes #3631.
+- Force cleanlooks style for kde only if the app is running from
+  bundle. Closes #3981.
+- Add a dropdown for known providers in the wizard. Closes #3995.
+- Separate pinned providers from user configures ones. Closes #3996.
+- Improve error handling during soledad bootstrap. Closes: #3965.
+  Affects: #3619, #3867, #3966
+- Implement new UI design. Closes #3973.
+- Make the initial provider cert verifications against our modified
+  CA-bundle (includes ca-cert certificates, for now). Closes: #3850
+- Use token header for authenticated requests. Closes #3910.
+- Do not distinguish between different possible authentication
+  errors. Fixes #3859.
+- Do not start Soledad if Mail is not enabled. Fixes #3989.
+- Allow window minization on OSX. Fixes #3932.
+- Properly stop the smtp daemon. Fixes #3873.
+
+0.3.3 Sep 20 -- "the calm after the tempest" release:
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+- Remove execution bits in text files in bundle. Closes #3617.
+- Use generic bad username/password message instead of specific ones when
+  the user uses incorrect data during login. Closes #3656.
+- Fix LoggerWindow saving more than one line return per line in the logs
+  file. Closes #3714.
+- Fix keyring imports so we do not get import errors. Closes: #3759
+- Catch logout problem, display a user message and allow log back in after a
+  successful logout if there was a logout error before. Closes #3774.
+- Fix path prefix helper for the bundle and add regresion tests. Closes #3778.
+- Prevent dialogs closing the app when it has been minimized to the tray. Closes #3791.
+- Do not try to install resolv-update globally. Closes: #3803
+- Inconsistent hide/show main window from tray action. Closes #3821.
+- Allow SMTP to start even when provider does not offer EIP. Closes: #3847
+- Fix username case problem at register/login. Closes #3857.
+- Catch IndexError on `first` utility.
+- Update git repo name in docs. Closes: #3417
+- Move STANDALONE flag to a module and unify get_path_prefix queries.
+  Closes #3636.
+- Display the Encrypted Internet and Encrypted Email status in the systray
+  tooltip. Closes #3758.
+- Tasktray menu changes, closes #3792.
+- Remove the provider domain item (e.g. bitmask.net).
+- Rename the EIP status menu items to be more descriptive.
+- Change the EIP status menu items from disabled menu items
+  to submenus with children.
+- Move the EIP action menu items under the EIP status submenu tree.
+- Adds ``--version`` flag. Closes: #3816
+- Refactors EIPConnection to use LEAPConnection state machine. Closes: #3900
+- Include resource files and ui in the distrubution tarball. Closes: #3825
+
+0.3.2 Sep 6 -- the "no crashes or anything" release:
+++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+- Fix up script in non-bundle linuces. Closes: #3450
+- Logout stops imap and smtp services. Closes: #3553
+- Properly daemonize polkit-gnome-authentication-agent. Closes: #3554
+- Set appropiate error on login cancel. Closes #3582.
+- Fix gateway selection problem. Closes 3595.
+- Fix typo in wizard: stablish -> establish. Closes #3615.
+- Display Encrypted Mail instead of mx in wizard. Closes #3657.
+- Fix save logs to file dialog freezing. Closes #3675.
+- Complain if setup.py is run with python3. Closes: #3711
+- Enable preferences option in systray. Closes #3717.
+- Make soledad emit failed signal for all kinds of socket error.
+- Allow to selectively silence logs from different leap components. Closes: #3504
+- Add option to select gateway manually in the preferences panel. Closes #3505.
+- Add preferences option to select the enabled services of a provider. Closes #3534.
+- Refactor basic password checks. Closes #3552.
+- Use dirspec instead of plain xdg. Closes #3574.
+- Remove last page from wizard. Closes #3616.
+- Display encrypted mail status in the tray. Closes #3659.
+
+0.3.1 Aug 23:
++++++++++++++
+
+- Replace wizard images with the rainbow mask. Closes #3425.
+- Update leap.common minimum version needed.
+- Set the standalone flag before it's being used. Fixes #3426.
+- Stop the twisted reactor adding the stop call to the call chain
+  instead of stopping it directly. Fixes #3406.
+- Allow soledad initialization to retry if it times out. Closes:
+  #3413
+- Activate window when setting it visible. Also display Hide/Show
+  message in the tray icon taking into account the window
+  activation. Fixes #3433.
+- Do not start IMAP daemon if mail was not selected among the
+  services. Fixes #3435.
+- Reword RECONNECTING state of openvpn. Fixes #3429.
+- Improve OpenVPN detection by searching for a specific leap-only
+  string in the command line. This makes it possible to run other
+  VPN instances while also using EIP. Fixes #3268 and #3364.
+- OSX: Check for the tun.kext existence in /Library/Extensions
+  instead of /System/Library/Extensions. Fixes #3271.
+- Use DELETE /1/logout to properly logout. Fixes #3510.
+- Make the poll interval bigger to improve openvpn's internal
+  behavior. If it gets queried too many times per second, it's
+  behavior won't be good. Fixes #3430.
+- Transforms usernames to lower case before they are used in the
+  registration and authentication. Closes #3541.
+- Add filter option to the logger window. Closes #3407.
+- Add a preference panel that lets you change your password. Closes
+  #3500 #2798 #3533.
+- Move all client code into its own namespace
+  (leap.bitmask). Closes: #2959
+- Make mail fetch interval in imap service configurable via
+  environment variable. Closes: #3409
+- Update to new soledad package scheme (common, client and
+  server). Closes #3487.
+- Fetch incoming mail when mail client logs in. Closes: #3525
+- Add first draft of the UI for Encrypted Mail. Closes #3499.
+
+0.3.0 Aug 9:
+++++++++++++
+
+- Add missing scripts does not stop if a command fails, also warns
+  the user if there was an error. Closes #3294.
+- Replace 'Sign Out' with 'Log Out' and 'User' with
+  'Username'. Closes #3319.
+- Verify cacert existence before using it. Closes bug #3362.
+- Properly handle login failures. Closes bug #3401.
+- Bugfix, avoid getting negative rates. Closes #3274.
+- Raise window when setting it as visible. Fixes #3374
+- Fail gracefully when the events port 8090 is in use by something
+  else. Fixes #3276.
+- Validate the username in the login form against the same regexp as
+  the wizard registration form. Fixes #3214.
+- Update text from the tray menu based on the visibility of the
+  window. Fixes #3400.
+- Add check for outdated polkit file. Closes #3209.
+- Add support for multiple schemas so we can support multiples api
+  versions. Closes #3310.
+- Rebrand the client to be named Bitmask. Feature #3313.
+- Add cancel button to login. Closes #3318.
+- Add multiple schema support for SMTP. Closes #3403.
+- Add multiple schema support for Soledad. Closes #3404.
+- Update Transifex project name and translators'
+  documentation. Closes #3418.
+- Add check for tuntap kext before launching openvpn. Closes: #2906
+- Accept flag for changing openvpn verbosity in logs. Closes: #3305
+- Add imap service to the client. Closes: #2579
+- Add pyside-uic support inside the virtualenv. This way it won't
+  fail to 'make' if the virtualenv is activated. Closes #3411.
+- Reintegrate SMTP relay module. Closes #3375
+- Reintegrate Soledad into the client. Closes #3307.
+- Support bundled gpg. Related to #3397.
+- Set the default port for SMTP to be 2013.
+- Display a more generic error message in the main window, and leave
+  the detailed one for the log. Closes #3373.
+
+0.2.4 Jul 26:
++++++++++++++
+
+- Use the provider CA cert for every request once we have it
+  bootstrapped (TOFU). Closes #3227.
+- Make calls to leap.common.events asynchronous. Closes #2937.
+- Always logout when closing the app if the user previously signed
+  in. Fixes #3245.
+- Make sure the domain field in provider.json is escaped to avoid
+  potential problems. Fixes #3244.
+- Fix incorrect handling of locks in Windows so that stalled locks
+  do not avoid raising the first instance of the app. Closes: #2910
+- Use traffic rates instead of totals. Closes #2913
+- Allow to alternate between rates and total throughput for the
+  virtual interface. Closes: #3232
+- Reset rates/totals when terminating connection. Closes #3249
+- Fix a bug in the displayed magnitude for the up/down traffic rates
+  and totals.
+- Force Cleanlooks style if we are running in a KDE environment, so
+  that it doesn't load potentially incompatible Qt libs. Fixes
+  #3194.
+- Wrap long login status messages to 40 characters. Fixes #3124
+- Workaround a segmentation fault when emitting a signal with its
+  last parameter being None. Fixes #3083.
+- Added IS_RELEASE_VERSION flag that allows us to use code only in
+  develop versions. Closes #3224.
+- Try to terminate already running openvpn instances. Closes #2916
+- Linux: Dynamically generate policy file for polkit. Closes #3208
+- Workaround some OpenVPN problems with priviledge dropping and
+  routing. Fixes #3178 #3135 #3207 #3203
+
+0.2.3 Jul 12:
++++++++++++++
+
+- Adapt code to Soledad 0.2.1 api.
+- Fix Main Window briefly display before the wizard on first
+  start. Closes Bug #2954.
+- Bugfix: Remember should not be automatically set to
+  checked. Closes #2955.
+- Bugfix: reload config if switching to a different provider. Closes
+  #3067.
+- Bugfix: logger window's toggle button reflects window
+  state. Closes #3152.
+- Set timeout for requests to 10 seconds globally, configurable from
+  leap.util.constants. Fixes #2878.
+- Bugfix: display error message on registration problem. Closes
+  #3039.
+- Make wizard use the main event loop, ensuring clean termination.
+- Use cocoasudo for installing missing updown scripts.
+- Bugfix: Systray Turn ON action fails because is not correctly
+  enabled/disabled. Closes #3125.
+- Bugfix: wrong systray icon on startup. Closes #3147.
+- Bugfix: parse line return in the logger window. Closes #3151.
+- Do not log user data on registration. Fixes #3168.
+- Add --log-append eip.log to windows EIP launcher options to save
+  the logs in case of any problems. Fixes #2054.
+- OSX: Make the install_path relative to the launcher path instead
+  -f absolute.
+- OSX: Fix icon display in cocoasudo.
+- OSX: Raise window when showing if running on OSX.
+- Bugfix: EIP status button moved to status panel.
+- Check if there is no gateway to use and display correct
+  message. Close #2921.
+- Reorder tray icons according new design. Closes #2919.
+- Redirect stdout/stderr and twisted log to the logger. Closes
+  #3134.
+- Improve LoggerWindow colors for easier debugging.
+- Move the key manager to its own repository/package.
+
+0.2.2 Jun 28:
++++++++++++++
+
+- Add support for the kde polkit daemon
+- Handle 'Incorrect Password' exception (keyring)
+- Select the configured domain in the providers combo box. Closes
+  #2693.
+- Remember provider along with the username and password. Closes
+  #2755.
+- Close the app on rejected wizard. Closes bug #2905.
+- Only use the Keyring when it's using a known good backend. Closes
+  #2960
+- Update implementation and semantics of the supported and available
+  services by a provider. Closes bug #3032.
+- Only show the question mark for a check being done if the previous
+  -ne passed. Fixes #2569.
+- Fix main client window not restoring after minimized into
+  systray. Closes #2574
+- Set EIP different status icons depending on OS. Closes #2643.
+- Reimplement openvpn invocation to use twisted ProcessProtocol
+- Add runtime requirements checker, verifies that the requirements
+  are installed and in its correct versions. Closes #2563
+- Add centraliced logging facility, log history in a window. Closes
+  #2566
+- Improve wizard, hide registration widgets (labels, inputs, button)
+  and only display a message. Closes #2694
+- Clarify labels through the app (use of EIP)
+- Check if the provider api version is supported. Closes feature
+  #2774.
+- Autoselect VPN gateway based on timezone. Closes #2790.
+- Disable vpn disconnect on logout. Closes #2795.
+- Improve gateway selector based on timezone. It allows to use
+  multiple gateways in openvpn for redundancy. Closes #2894.
+- Use cocoasudo in place of osascript for osx privilege escalation
+  during openvpn launch.
+- Clicking in the tray icon will always show the context menu
+  instead of activating the window under certain
+  circumstances. Closes #2788
+- Autostart EIP whenever possible. Closes #2815
+- Update test suite, run_scripts and requirements to run smoothly
+  with buildbot.
+- Add a copy of the processed requirements to util/
+- Display the default provider configured in the systray menu. Close
+  #2813
+- Make the login steps be a chain of defers in order to be able to
+  have more cancel points for the whole procedure. Closes #2571
+- Linux: check for up/down scripts and policy files and ask user for
+  permission to install them in a root-writeable location. Used from
+  within bundle or for broken installations.
+- Integrate SMTP-Relay into the client.
+- Integrate Soledad and KeyManager.
+- Move the KeyManager from leap.common to leap-client.
+- Only use one systray icon, repesenting the status for EIP. Closes
+  #2762
+- Properly set the binary manifest to the windows openvpn
+  binary. Closes #203
+- OSX: Add dialog with suggestion to install up/down scripts if
+  these not found. Closes: #1264, #2759, #2249
+- Workaround for PySide breaking with multiple inheritance. Closes
+  #2827
+- Refactor login to its own widget and remove Utils menu. Closes
+  #2789
+- Refactor the status bits out of the MainWindow to its own
+  StatusPanelWidget. Closes #2792
+- Save the default provider to be used for autostart EIP as
+  DefaultProvider in leap.conf. Closes #2793
+- Cleanly terminate openvpn process, sending SIGTERM and SIGKILL
+  after a while. Closes #2753
+- Use twisted's deferToThread and Deferreds to handle parallel tasks
+- Use a qt4 reactor for twisted, for launching leap twisted
+  services.
+
+0.2.1 May 15:
++++++++++++++
+
+- Rewrite most of the client based on the insight gained so far.
+- Deselecting the remember checkbox makes the app not populate
+  user/password values on the login widget. Closes #2059
+- Rewording of setup steps in wizard, to make them more meaningful
+  to the non-technical user. Closes #2061
+- Fix typo in wizard.
+- Fix multiple drawing of services if going back.
+- Make registration errors show in red.
+- Add a warning if EIP service needs admin password. Addresses part
+  -f #2062
+- Make traffic indicators display fixed precision. Closes #2114
+- Do not hide the application if the user right clicked the system
+  tray icon.
+- Sanitize network-fetched content that is used to build openvpn
+  command.
+- Avoids multiple instances of leap-client. Each new one just raises
+  the existing instance and quits.
+- Use dark eip icons os osx. Closes #2130
+- Moves BaseConfig to leap.common.config. Closes #2164
+- Add handling for ASSIGN_IP state from OpenVPN in the mainwindow.
+- Emit events notifying of the session_id and uid after
+  authentication so other services can make use of it. Closes #1957
+- Working packaging workflow with rewritten client, using
+  pyinstaller and platypus.
+- Remove network checks temporarily until we find a good way of
+  doing it, and a good way to deal with them.
+- Saves the token to allow token authenticated queries.
+- Turn "leap" into namespace package, move common files to
+  leap_common package that can be shared by other LEAP projects.
+- Support standalone configurations for distribution in thumbdrives
+  and the like.
+- Add support for requests < 1.0.0
+- Tests infrastructure, and tests for crypto/srpauth and crypto/srpregister.
+- Documentation updated for 0.2.1 release.
+- Docstrings style changed to fit sphinx autodoc format.
+- Add a simple UI to notify of pending updates.
+- Add Windows support.
+- Try to install TAP driver on Windows if no tap device is preset.
diff --git a/MANIFEST.in b/MANIFEST.in
index 876393da..73355b99 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -6,7 +6,7 @@ prune docs/covhtml
 include versioneer.py
 include LICENSE
 include README.rst
-include CHANGELOG
+include CHANGELOG.rst
 include src/leap/bitmask/util/reqs.txt
 include src/leap/bitmask/crypto/tests/wrongcert.pem
 
diff --git a/README.rst b/README.rst
index a4272c40..811cfdfa 100644
--- a/README.rst
+++ b/README.rst
@@ -1,5 +1,6 @@
 Bitmask
 =======
+
 *your internet encryption toolkit*
 
 .. image:: https://pypip.in/v/leap.bitmask/badge.png
@@ -7,6 +8,7 @@ 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.
@@ -35,7 +37,7 @@ Bitmask depends on these libraries:
 Python packages are listed in ``pkg/requirements.pip`` and ``pkg/test-requirements.pip``
 
 Getting dependencies under debian
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+++++++++++++++++++++++++++++++++++
 
 With a Debian based system, to be able to run Bitmask you need to run the following command::
 
diff --git a/setup.py b/setup.py
index 78c5b0fb..fd87e56c 100755
--- a/setup.py
+++ b/setup.py
@@ -168,25 +168,8 @@ setup(
     cmdclass=cmdclass,
     description=("The Internet Encryption Toolkit: "
                  "Encrypted Internet Proxy and Encrypted Mail."),
-    # XXX unify the long_description on a file of its own, so we
-    # can reuse it easily.
-    long_description=(
-        "Bitmask is the multiplatform desktop client for the LEAP Platform."
-        "\n"
-        "The LEAP Encryption Access Project develops "
-        "a multi-year plan to secure everyday communication.\n "
-        "The Encrypted Internet Proxy (EIP) provides circumvention, location "
-        "anonymization, and traffic encryption in a hassle-free, "
-        "automatically self-configuring fashion.\n"
-        "Encrypted Mail offers automatic encryption and decryption for "
-        "both outgoing and incoming email, adding public key cryptography "
-        "to your mail without you ever having to worry about key distribution "
-        "or signature verification. \n"
-        "The Encrypted Mail services will run local SMTP and IMAP proxies "
-        "that, once you configure the mail client of your choice, will "
-        "automatically encrypt and decrypt your email using GPG encryption "
-        "under the hood."
-    ),
+    long_description=open('README.rst').read() + '\n\n\n' +
+    open('CHANGELOG.rst').read(),
     classifiers=trove_classifiers,
     install_requires=parsed_reqs,
     test_suite='nose.collector',