From 8e48027f4510b8ed3f1bb279eb0cbdd7292a67fd Mon Sep 17 00:00:00 2001
From: Matt Stone <matt@fulcrumgenomics.com>
Date: Sun, 24 Mar 2024 21:06:45 -0400
Subject: [PATCH] wip: example usage

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

diff --git a/README.md b/README.md
index d353fb0..87616e9 100644
--- a/README.md
+++ b/README.md
@@ -7,4 +7,38 @@
 
 Dataclass IO.
 
+## Usage
 
+```py
+from dataclasses import dataclass
+from dataclass_io import DataclassReader
+
+
+@dataclass
+class MyData:
+    foo: int
+    bar: str
+
+
+with DataclassReader(path, MyData) as reader:
+    for record in reader:
+        do_something(record.foo)
+```
+
+
+```py
+from dataclasses import dataclass
+from dataclass_io import DataclassWriter
+
+
+@dataclass
+class MyData:
+    foo: int
+    bar: str
+
+
+with DataclassWriter(path, MyData) as writer:
+    for i in range(3):
+        record = MyData(foo=i, bar="something")
+        writer.write(record)
+```