Merge pull request #1503 from joshuagl/joshuagl/readme-refactor

Add information about current project state/refactor to the README

Author: joshuagl

README.md

@@ -9,10 +9,37 @@
 This repository is the **reference implementation** of
 [The Update Framework (TUF)](https://theupdateframework.github.io/).
 It is written in Python and intended to conform to version 1.0 of the
-[TUF specification](https://github.com/theupdateframework/specification/blob/master/tuf-spec.md).
-This implementation is in use in production systems, but is also intended to be
-a readable guide and demonstration for those working on implementing TUF in
-their own languages, environments, or update systems.
+[TUF specification](https://theupdateframework.github.io/specification/latest/).
+
+The repository currently includes two implementations:
+1) A *legacy implementation*, with
+   [`tuf/client/updater.py`](tuf/client/updater.py) implementing the detailed
+   client workflow and [`tuf/repository_tool.py`](tuf/repository_tool.py)
+   providing a high-level interface for repository operations.
+   The legacy implementation is in use in production systems, but is [no longer
+   being actively worked on](docs/adr/0002-pre-1-0-deprecation-strategy.md).
+2) A *modern implementation*. We are in the process of rewriting the reference
+   implementation in [modern Python](docs/adr/0001-python-version-3-6-plus.md)
+   to both: a) address scalability and integration issues identified in
+   supporting integration into the Python Package Index (PyPI), and other
+   large-scale repositories, and b) to ensure maintainability of the project.
+   This implementation consists of:
+   * a "low-level" metadata API, designed to provide easy and safe access to
+     TUF metadata and handle (de)serialization from/to files, provided in the
+     [`tuf/api/metadata.py`](tuf/api/metadata.py) module.
+   * an implementation of the detailed client workflow built on top of the
+     metadata API, provided in the
+     [`tuf/ngclient/updater.py`](tuf/ngclient/updater.py) module.
+   The modern implementation is not considered production ready and does not yet
+   provide any high-level support for implementing
+   [repository operations](https://theupdateframework.github.io/specification/latest/#repository-operations),
+   though the addition of API to support them is planned.
+
+
+
+The reference implementation strives to be a readable guide and demonstration
+for those working on implementing TUF in their own languages, environments, or
+update systems.
 
 
 About The Update Framework
@@ -39,7 +66,7 @@ Please see the [TUF Introduction](docs/OVERVIEW.rst) and
 Documentation
 -------------
 * [Introduction to TUF's Design](docs/OVERVIEW.rst)
-* [The TUF Specification](https://github.com/theupdateframework/specification/blob/master/tuf-spec.md)
+* [The TUF Specification](https://theupdateframework.github.io/specification/latest/)
 * [Getting Started with the TUF Reference Implementation](docs/GETTING_STARTED.rst)
 * [Governance](docs/GOVERNANCE.md) and [Maintainers](docs/MAINTAINERS.txt)
 for the reference implementation