summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYuval Adam <_@yuv.al>2024-05-07 21:05:47 +0200
committerYuval Adam <_@yuv.al>2024-05-07 21:05:47 +0200
commitfd03940bd8d73dd9109c756a65b6e479903c1e58 (patch)
tree60149ecb70773b22742a63def5c9ca1755116c90
parent1c44a07b1cdc729357e21e2ca97de0917de37e12 (diff)
Update README
-rw-r--r--README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/README.md b/README.md
index 0ff8848..0a0aa82 100644
--- a/README.md
+++ b/README.md
@@ -18,7 +18,7 @@ class User:
key: ClassVar[str] = "name"
```
-Note the special `key` field which is used to denote that `name` should be used as the primary key field.
+Note the special `key` field which is used to denote that `name` should be used as the primary key field. If an object has `name: "foo"`, it will be saved as `foo.yml` in the stash root directory.
Instantiate a new object: