Added feature-table and usage.

This commit is contained in:
The Wobbler 2025-03-15 17:18:24 +01:00
parent 03ea689bff
commit c6df2441f8

View file

@ -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
```