summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYuval Adam <_@yuv.al>2024-05-07 15:15:36 +0200
committerYuval Adam <_@yuv.al>2024-05-07 15:15:36 +0200
commite145993440b3ba8c65aa6fa0ef9c0f1040d1e70f (patch)
treeab308b7100c9ade805ae44bb28104ba6e902bdf3 /README.md
parentff8a02880aa214bc95ec0b836a3a88853f7df110 (diff)
Update basic README
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index e69de29..e289a88 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,13 @@
+# ymlstash
+
+A simple ORM-like utility for operating on local YAML files via Python dataclasses.
+
+Define a dataclass:
+
+```python
+@dataclass
+class User:
+ name: str
+ age: int
+ active: bool
+```