docs: update README with snapshot description

mswjs · Apr 28, 2021 · 1a5e22a · 1a5e22a
1 parent eefa978
commit 1a5e22a
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -657,6 +657,23 @@ const db = factory({...})
 drop(db)
 ```
 
+#### `snapshot`
+
+Create a snapshot for entities present in the database.
+The snapshot is useful to restore the database later e.g. between tests.
+
+```js
+import { factory, snapshot } from '@mswjs/data'
+
+const db = factory({...})
+
+const restore = snapshot(db)
+
+// Make some update to the database
+
+restore()
+```
+
 ### Usage with `faker`
 
 Libraries like [`faker`](https://github.com/Marak/Faker.js) can help you generate fake data for your models.