Update readme

florianeinfalt · Mar 21, 2017 · 193e4aa · 193e4aa
1 parent 9ab2430
commit 193e4aa
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -111,4 +111,11 @@ To update the API data, type:
 
     api_cache.update('project_data')
 
+To diff existing API data with new API data, type:
+
+.. code-block:: python
+
+    api_cache.diff('project_data')
+    # {'project_data': {'values_changed': {"root['headers']['X-Request-Id']": {'new_value': u'f5800c5e-4edb-4509-8339-4bcdf0b32732', 'old_value': u'd8ed6737-e5c8-49aa-b42e-58eb2ba472b9'}}}}
+
 .. _Full Documentation: http://nukedatastore.readthedocs.io/en/latest/