From c6df2441f8af927b2de9d50810ae6e6fbe8a8c43 Mon Sep 17 00:00:00 2001
From: The Wobbler <emil@i21k.de>
Date: Sat, 15 Mar 2025 17:18:24 +0100
Subject: [PATCH] Added feature-table and usage.

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

diff --git a/README.md b/README.md
index 0cb4bcf..614caad 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,54 @@
 # SmallTag
 
 A module that extends TinyTag's capabilities by also writing tags.
+
+### Features
+
+| Feature     | Sub-Features                                                      | State                                                  |
+|-------------|-------------------------------------------------------------------|--------------------------------------------------------|
+| ID3-Writing | <input type="checkbox" disabled checked> Writing Of String Frames | <input type="checkbox" disabled> Partially Implemented |
+
+## Usage
+
+> [!CAUTION]
+> Please note that this module is still in development and could corrupt the audio file.
+
+Reading works in exactly the same way as with TinyTag. \
+Example:
+
+```Python3
+from smalltag import SmallTag
+
+tag = SmallTag.get("test.mp3")
+
+print(tag.title)
+# Example Output: Test
+```
+
+But this module also adds support for writing metadata.
+Just use the `write()`-function on a loaded tag to write the metadata to the file. \
+Example:
+
+```Python3
+from smalltag import SmallTag
+
+tag = SmallTag.get("test.mp3")
+
+print(tag.title)
+# Example Output: Test
+
+tag.title = "Another Test"
+
+tag.write()
+```
+
+When you then load the metadata again, you will see that the title has changed:
+
+```Python3
+from smalltag import SmallTag
+
+tag = SmallTag.get("test.mp3")
+
+print(tag.title)
+# Example Output: Another Test
+```
\ No newline at end of file