Update README.rst to reflect syntax changes to stackviz-export

README.rst

@@ -16,6 +16,10 @@ Then, install the Bower components by running, from the project directory::
 
     bower install
 
+Lastly, install the project. Pip is recommended, like so::
+
+    sudo pip install .
+
 Usage - Server
 ==============
 First, install the necessary dependencies with Pip::
@@ -31,15 +35,18 @@ You can then browse to the printed URL in your browser of choice.
 Usage - Static Site
 ===================
 The server can be "snapshotted" and exported to a static HTML site using the
-:code:`export_static.py` utility. StackViz can then be viewed using any web
+installed :code:`stackviz-export` utility. StackViz can then be viewed using any
-browser with no requirement of any server-side processing.
+web browser with no requirement of any server-side processing.
 
 To generate, run::
 
-    python export_static.py dest_dir
+    stackviz-export -r path/to/testrepository/ dest_dir
 
 ... where `dest_dir` is the path to a target directory where files should be
 written. When finished, the :code:`index.html` file can be opened in a browser.
+Note that the above gathers test data from a `testrepository` directory, though
+direct subunit streams either from files or standard input are also supported.
+For more information, see `stackviz-export --help`.
 
 Note that some browsers enforce content origin policies that may disallow
 XHRs when viewed directly from the local filesystem. To work around this, you
@@ -52,7 +59,7 @@ GZipped Data
 As the log data can become quite large, exported files can be compressed with
 GZip to significantly reduce the size of the data files. To enable, run::
 
-    python export_static.py --gzip dest_dir
+    stackviz-export -r path/to/testrepository/ --gzip dest_dir
 
 Data files will then be written in compressed form, and will be suffixed with
 :code:`*.json.gz`. Note that web servers must be properly configured to serve
@@ -68,16 +75,25 @@ without any extra configuration.
 (Specifically, the response must have headers
 :code:`Content-Type: application/json` and :code:`Content-Encoding: gzip`.)
 
+DStat Data
+----------
+StackViz will also show charts generated from
+`DStat logs <http://dag.wiee.rs/home-made/dstat/>`_, if available. Note that
+console output from DStat is not sufficient - a CSV logfile must be used. Then,
+provide the logfile to :code:`stackviz-export`::
+
+    stackviz-export -r testrepository/ --dstat path/to/dstat.csv dest_dir
+
 Log Locations
 =============
 Log locations are configured along with normal Django settings in
-:code:`stackviz/settings.py`. Several different types of logs are rendered by
+:code:`stackviz/settings.py`, or specified as command-line arguments to
-StackViz:
+:code:`stackviz-export`. Several different types of logs are rendered by
+StackViz are read by default from:
 
-* Tempest (`testr` repositories): :code:`./test_data/`,
+* Tempest (`testr` repositories): :code:`./test_data/`
-  :code:`/opt/stack/tempest/`
+* Dstat: :code:`./dstat.log`
 * DevStack: *TODO*
-* Dstat: *TODO*
 
 Testing
 =======