diff --git a/README.rst b/README.rst index 7f381fdc..e393c708 100644 --- a/README.rst +++ b/README.rst @@ -20,20 +20,20 @@ In addition to the standard wayback machine (explained further below), pywb tool number of useful command-line and web server tools. The tools should be available to run after running ``python setup.py install`` -``live-rewrite-server`` -- a demo live rewriting web server which accepts requests using wayback machine url format at ``/rewrite/`` path, eg, ``/rewrite/http://example.com/`` +* ``live-rewrite-server`` -- a demo live rewriting web server which accepts requests using wayback machine url format at ``/rewrite/`` path, eg, ``/rewrite/http://example.com/`` and applies the same url rewriting rules as are used for archived content. This is useful for checking how live content will appear when archived before actually creating any archive files, or for recording data. The `webrecorder.io `_ service is built using this tool. -``cdx-indexer`` -- a command-line tool for creating CDX indexs from WARC and ARC files. Supports SURT and +* ``cdx-indexer`` -- a command-line tool for creating CDX indexs from WARC and ARC files. Supports SURT and non-SURT based cdx files and optional sorting. See ``cdx-indexer -h`` for all options. for all options. -``cdx-server`` -- a CDX API only server which returns a responses about CDX captures in bulk. +* ``cdx-server`` -- a CDX API only server which returns a responses about CDX captures in bulk. Includes most of the features of the `original cdx server implementation `_, updated documentation coming soon. -``wayback`` -- The full Wayback Machine application, further explained below. +* ``wayback`` -- The full Wayback Machine application, further explained below. Latest Changes