Commits

Jop de Klein committed 318a51b

Added initial API documentation

Comments (0)

Files changed (1)

+Snap API
+========
+
+* snap.getSnapshotIndex()
+
+* snap.getSnapshot()
+* snap.getSnapshotByURL(url)
+* snap.getSnapshotById(id)
+
+* snap.saveSnapshot(metadata)
+    * meta:: 
+    {
+        'id': 'foo',
+        'url': 'http://localhost/foo',
+        'userAgent': 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_5_8; en-US) AppleWebKit/533.4 (KHTML, like Gecko) Chrome/5.0.375.70 Safari/533.4'
+    }