From c0056b2d9f5175d06b39834b013d16fa5d63a485 Mon Sep 17 00:00:00 2001
From: Yuval Adam <_@yuv.al>
Date: Tue, 7 May 2024 15:44:46 +0200
Subject: Setup pytest and assert stash path

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

(limited to 'README.md')

diff --git a/README.md b/README.md
index e289a88..ee3df48 100644
--- a/README.md
+++ b/README.md
@@ -5,9 +5,26 @@ A simple ORM-like utility for operating on local YAML files via Python dataclass
 Define a dataclass:
 
 ```python
+from dataclasses import dataclass
+
 @dataclass
 class User:
     name: str
     age: int
     active: bool
 ```
+
+Instantiate a new object:
+
+```python
+user = User(name="yuval", age=42, active=True)
+```
+
+Save it to file:
+
+```python
+from ymlstash import YmlStash
+
+stash = YmlStash("path/to/db")
+stash.save(user)
+```
-- 
cgit v1.3.1