Skip to content

Commit

Permalink
📝 Updated README.md
Browse files Browse the repository at this point in the history
- Example was outdated, thus did not work anymore
- Supported versions was outdated
- Added note about the progress
- Future features was also outdated
  • Loading branch information
rhorber committed May 5, 2020
1 parent e7296c2 commit a16e14c
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,13 @@

> PHP-Library for reading and writing ID3 tags.
> The Library yet only supports parsing of Version 2.3.0 and Version 2.4.0, and writing Version 2.4.0.
> The Library supports versions 2.3.0 and 2.4.0.
> ℹ The library is in early development stage, but if possible the current API (public methods) will not change.
> ⚠ As I have limited time to work on this library it progresses slowly.
> If you have any suggestions or questions, or you need a feature, feel free to file an issue.
This project adheres to [Semantic Versioning](https://semver.org/).


Expand All @@ -18,11 +21,11 @@ $frames = $reader->getFrames();
print_r($frames);

// Change title.
$frames['TIT2']['content'] = '2018-10-21_'.$frames['TIT2']['content'];
$frames['TIT2']['information'] = '2018-10-21_'.$frames['TIT2']['information'];

// Write a new file (with modified title).
$writer = new \Rhorber\ID3rw\Writer();
$writer->writeNewFiel($frames, '/home/user/mynewfile.mp3');
$writer->writeNewFile($frames, '/home/user/mynewfile.mp3', '/home/user/myfile.mp3');
```


Expand All @@ -36,17 +39,18 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
## TODO

Features I will add:
* Add functionality to `Reader` to return the frames as objects.
* Write tests for the `Writer`.
* Add more writing variants and expand their docs.
* Support more versions (at least V2.3.0).
* Improve parsing of non-text frames.
* Return detailed info about frames (not only technical name).
* Improve readme.
* Eventually support more versions (2.3.0 and 2.4.0 are the most common ones).

- Add names and/or descriptions to the frames.
- Add the lists of frames (TCON, TFLT, TMED (TKEY), ETCO, APIC)
- Add notices when displaying TCOP and TPRO

=> rename index `content`, maybe to `parsed` (and move optional `encoding` into it).

## About/History

Expand Down

0 comments on commit a16e14c

Please sign in to comment.