From 58949c361a8170e46a279e4c1824c0a9414a26d1 Mon Sep 17 00:00:00 2001
From: Yuval Adam <_@yuv.al>
Date: Tue, 7 May 2024 21:01:24 +0200
Subject: Update README

---
 README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/README.md b/README.md
index 25737d2..6b9b07a 100644
--- a/README.md
+++ b/README.md
@@ -35,6 +35,14 @@ stash = YmlStash(User, "path/to/db")
 stash.save(user)
 ```
 
+This will create a `yuval.yml` file in the stash root directory.
+
+When saving to file, a `key` field must be present on the dataclass, otherwise an explicit `key` must be passed:
+
+```python
+stash.save(obj, key="custom-key")
+```
+
 Load from file:
 
 ```python
-- 
cgit v1.3.1