Merge pull request #232 from gene1wood/prepare-for-archive

Update docs and package to be archived

README.md

@@ -1,17 +1,22 @@
 # TLS Canary
 
-[![Build Status](https://travis-ci.org/mozilla/tls-canary.svg?branch=master)](https://travis-ci.org/mozilla/tls-canary)
+## Status : Archived
+
+This project is no longer maintained and has been archived. No further work will
+be done on it including security fixes. Feel free to fork the project if you'd
+like to extend it.
+
+## Description
+TLS Canary was a [TLS/SSL](https://en.wikipedia.org/wiki/Transport_Layer_Security) testing framework for the
+[Mozilla Firefox](https://www.mozilla.org/firefox) web browser. It was used by developers to run regression and
+performance tests against a large number of HTTPS-enabled hosts on the Internet.
+
 [![License](https://img.shields.io/badge/license-MPL2-blue.svg)](https://raw.githubusercontent.com/mozilla/tls-canary/master/LICENSE.txt)
 [![PyPI Package version](https://badge.fury.io/py/tlscanary.svg)](https://pypi.python.org/pypi/tlscanary)
 
-TLS Canary is a [TLS/SSL](https://en.wikipedia.org/wiki/Transport_Layer_Security) testing framework for the
-[Mozilla Firefox](https://www.mozilla.org/firefox) web browser. It is used by developers to run regression and
-performance tests against a large number of HTTPS-enabled hosts on the Internet.
-
-Results of the regression scans are published in HTML format here:
-* http://tlscanary.mozilla.org
-
 ## This project
+
+ 
 * Downloads a test build and a base build of Firefox for comparison.
 * Automatically queries thousands of secure sites with those builds.
 * Diffs the results and presents potential regressions in an report for further diagnosis.
@@ -21,10 +26,6 @@ Results of the regression scans are published in HTML format here:
 * Can maintain an updated list of HTTPS-enabled top sites.
 * Requires a highly reliable network link. **WiFi will give unstable results.**
 
-## IRC channel
-The project has a dedicated IRC channel: [#tlscanary on irc.mozilla.org](
-https://mibbit.com/?server=irc.mozilla.org&channel=%23tlscanary). Come talk to us!
-
 ## Requirements
 * Python 3.6+
 * 7zip
@@ -77,11 +78,6 @@ pip3 install [--user] --upgrade tlscanary
 Whether or not you require the `--user` flag depends on how your Python environment is set up. Most Linux distributions
 require it when not installing Python packages as root.
 
-If you prefer the bleeding-edge developer version with the latest features and added instability, you can run
-```
-pip3 install [--user] --upgrade git+git://github.com/mozilla/tls-canary.git
-```
-
 Once it finishes the `tlscanary` binary is available in your Python environment:
 ```
 tlscanary --help

README.rst

@@ -1,13 +0,0 @@
-TLS Canary
-==========
-
-`TLS Canary <https://github.com/mozilla/tls-canary>`_ is a
-`TLS/SSL <https://en.wikipedia.org/wiki/Transport_Layer_Security>`_ testing framework for the
-`Mozilla Firefox <https://www.mozilla.org/firefox>`_ web browser. It is used by developers to run
-regression and performance tests against a large number of HTTPS-enabled hosts on the Internet.
-
---------
-
-The TLS Canary Python package has several non-Python dependencies that need to be satisfied for the script to run.
-For installation instructions, usage information, and issue tracking, please visit the `Project Page
-<https://github.com/mozilla/tls-canary>`_ on GitHub.

setup.py

@@ -5,7 +5,7 @@
 from setuptools import setup, find_packages
 
 PACKAGE_NAME = 'tlscanary'
-PACKAGE_VERSION = '4.0.1a1'
+PACKAGE_VERSION = '4.0.2'
 
 INSTALL_REQUIRES = [
     'coloredlogs',
@@ -30,13 +30,18 @@ TESTS_REQUIRE = [
 
 DEV_REQUIRES = TESTS_REQUIRE + SCHEDULER_REQUIRES
 
+with open(path.join(here, 'README.md'), encoding='utf-8') as f:
+    long_description = f.read()
+
 setup(
     name=PACKAGE_NAME,
     version=PACKAGE_VERSION,
     description='TLS/SSL Test Suite for Mozilla Firefox',
+    long_description=long_description,
+    long_description_content_type='text/markdown',
     classifiers=[
         'Environment :: Console',
-        'Development Status :: 5 - Production/Stable',
+        'Development Status :: 7 - Inactive',
         'Intended Audience :: Developers',
         'License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)',
         'Natural Language :: English',