Merge f01fa50 into 02bc777

README.rst

@@ -1,29 +1,79 @@
-Webrecorder pywb 2.0
-====================
+pywb 2.0 beta
+=============
 
 .. image:: https://travis-ci.org/ikreymer/pywb.svg?branch=master
       :target: https://travis-ci.org/ikreymer/pywb
 .. image:: https://coveralls.io/repos/ikreymer/pywb/badge.svg?branch=master
       :target: https://coveralls.io/r/ikreymer/pywb?branch=master
 
-**pywb** is a Python (2 and 3) web archive replay and recording toolkit.
+Web Archiving Tools for All
+---------------------------
 
-This toolset forms the foundation of Webrecorder, but also provides a variety of web archiving tools,
-such as the traditional "Wayback Machine" functionality.
+`View the full pywb 2.0 documentation here <https://pywb.readthedocs.org>`_
 
-Note: this version, which represents a major overhaul of pywb, is not yet released on pypi, but you can:
+**pywb** is a Python (2 and 3) web archiving toolkit for replaying web archives large and small as accurately as possible.
+The toolkit now also includes new features for creating high-fidelity web archives.
+
+This toolset forms the foundation of Webrecorder project, but also provides a generic web archiving toolkit
+that is used by other web archives, including the traditional "Wayback Machine" functionality.
+
+
+New Features
+^^^^^^^^^^^^
+
+The 2.0 beta release includes a major overhaul of pywb and introduces the following new features, including:
+
+* Dynamic multi-collection configuration system with no-restart updates.
+
+* New recording capability to create new web archives from the live web or other archives.
+
+* Componentized architecture with standalone Warcserver, Recorder and Rewriter components.
+
+* Support for advanced "memento aggregation" and fallback chains for querying multiple remote and local archival sources.
+
+* HTTP/S Proxy Mode with customizable Certificate Authority for proxy mode recording and replay.
+
+* Flexible rewriting system with pluggable rewriters for different content-types.
+
+* Significantly improved client-side rewriting to handle most modern web sites.
+
+
+Please see the `full documentation <https://pywb.readthedocs.org>`_ for more detailed info on all these features.
+
+
+Work in Progress / Coming Soon
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+A few key features are high on list of priorities, but have not yet been implemented, including:
+
+* Url Exclusion System
+
+* New Default UI (calendar and banner)
+
+If you are intersted in contributing, especially to any of these areas, please let us know!
+
+
+Installation
+------------
+
+To run and install locally you can:
 
 * Install with ``python setup.py install``
 
 * Run tests with ``python setup.py test``
 
 * Run Wayback with ``wayback`` (see docs for info on how to setup collections)
 
-* Build docs locally with:  ``cd docs; make html``
+* Build docs locally with:  ``cd docs; make html``. (The docs will be built in `./_build/html/index.html`)
+
+
+Consult the local or `online docs <https://pywb.readthedocs.org>`_ for latest usage and configuration details.
 
-* ..and a lot more!
 
-Please see the `Webrecorder pywb documentation for usage and configuration info <https://pywb.readthedocs.org>`_
+Contributions & Bug Reports
+---------------------------
 
+Users are encouraged to fork and contribute to this project to keep improving web archiving tools.
 
+Please take a look at list of current issues and feel free to open new ones about any aspect of pywb, including the new documentation.
 

docs/conf.py

@@ -170,7 +170,7 @@
 #  dir menu entry, description, category)
 texinfo_documents = [
     (master_doc, 'pywb', 'pywb Documentation',
-     author, 'pywb', 'One line description of project.',
+     author, 'pywb', 'Web Archiving Tools for All.',
      'Miscellaneous'),
 ]
 

docs/index.rst

@@ -6,16 +6,18 @@
 Webrecorder pywb documentation!
 ================================
 
-Webrecorder (:mod:`pywb`) toolkit is a full-featured, advanced web archiving capture and replay framework for python.
+The Webrecorder (:mod:`pywb`) toolkit is a full-featured, advanced web archiving capture and replay framework for python.
 It provides command-line tools and an extensible framework for high-fidelity web archive access and creation.
+A subset of features provides the basic functionality of a "Wayback Machine".
+
 
 .. toctree::
    :maxdepth: 2
 
-   manual/intro
    manual/usage
    manual/configuring
-   manual/index
+   manual/architecture
+   manual/cdxserver_api
    code/pywb
 
 

docs/manual/apps.rst

@@ -0,0 +1,4 @@
+Command-Line Apps
+=================
+
+

docs/manual/architecture.rst

@@ -0,0 +1,19 @@
+Architecture
+============
+
+The pywb system consists of 3 distinct components: Warcserver, Recorder and Rewriter, which can be run and scaled separately.
+The default pywb wayback application uses Warcserver and Rewriter. If recording is enabled, the Recorder is also used.
+
+Additionally, the indexing system is used through all components, and a few command line tools encompass the pywb toolkit.
+
+
+.. toctree::
+   :maxdepth: 2
+
+   warcserver
+   recorder
+   rewriter
+
+   indexing
+   apps
+