From e145993440b3ba8c65aa6fa0ef9c0f1040d1e70f Mon Sep 17 00:00:00 2001
From: Yuval Adam <_@yuv.al>
Date: Tue, 7 May 2024 15:15:36 +0200
Subject: Update basic README

---
 README.md      | 13 +++++++++++++
 pyproject.toml |  4 ++--
 2 files changed, 15 insertions(+), 2 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
+```
diff --git a/pyproject.toml b/pyproject.toml
index 449b84e..4b48436 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "ymlstash"
-version = "0.1.0"
-description = ""
+version = "1.0.0"
+description = "A simple ORM-like utility for operating on local YAML files via Python dataclasses"
 authors = ["Yuval Adam <_@yuv.al>"]
 readme = "README.md"
 
-- 
cgit v1.3.1