Skip to content

Commit 015a1d1

Browse files
committed
README updated and TODO added
1 parent 23e2108 commit 015a1d1

File tree

3 files changed

+29
-7
lines changed

3 files changed

+29
-7
lines changed

CHANGELOG.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,14 @@ All notable changes to this project will be documented in this file.
33
This project adheres to [Semantic Versioning](http://semver.org/).
44

55
## [Unreleased]
6+
### Added
7+
- Spotify
8+
- Album
69
### Changed
7-
- _internal_ Optimalizations
10+
- Dependencies
811
- _internal_ Unit tests
12+
### Removed
13+
- **PHP 5.5 support**
914

1015
## [0.0.2] - 2016-12-01
1116
### Added

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ This PHP library enables you to combine multiple music related API Services to l
77
## Requirements ##
88
In order to use this library your environment MUST meet the following criteria:
99
* PHP 5.6 (or later)
10+
* curl extension
1011

1112

1213
## Installation ##
@@ -92,17 +93,21 @@ music_info:
9293
9394
## Services ##
9495
95-
| | Version | General | Track | Artist | Album | Comments |
96-
|---|:-------:|:-------:|:-----:|:------:|:-----:|:--------:|
97-
|Spotify | 0.1 | :white_check_mark: | :white_check_mark: | :white_check_mark: | :heavy_multiplication_x: ||
98-
|VocaDB | 0.1 | :white_check_mark: | :heavy_multiplication_x: | :white_check_mark: | :heavy_multiplication_x: ||
99-
|MusicBrains | 0.1 | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_multiplication_x: ||
100-
|~~Echonest~~ | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_multiplication_x: | Service cancelled in favor of Spotify [[1]](http://developer.echonest.com/docs/v4) |
96+
| | Version | General | Track | Artist | Album | Comments |
97+
|--- |:-------: |:-------: |:-----: |:------: |:-----: |:--------:|
98+
|Spotify | 0.1 | :white_check_mark: | :white_check_mark: | :white_check_mark: | :heavy_multiplication_x: ||
99+
|VocaDB | 0.1 | :white_check_mark: | :heavy_multiplication_x: | :white_check_mark: | :heavy_multiplication_x: ||
100+
|MusicBrains | 0.1 | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_multiplication_x: ||
101+
|Discogs | N/A | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_multiplication_x: ||
102+
|~~Echonest~~ | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_multiplication_x: | Service cancelled in favor of Spotify [[1]](http://developer.echonest.com/docs/v4) |
101103
102104
## Changelog
103105
104106
Please see [CHANGELOG.md](CHANGELOG.md)
105107
108+
## Todo
109+
110+
Please see [TODO.md](TODO.md)
106111
107112
## License
108113

TODO.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# To-Do
2+
3+
This document lists all planned features for future releases.
4+
Please note that this document does not guarantee the addition of these features.
5+
**The list is in no particular order**
6+
7+
* Suggest corrections
8+
* Cache mechanism
9+
* Job system
10+
* Prevent ban from API exhaustion (rate limit exceeding)
11+
* More modular system
12+
* Allow adding support for extra services without adding it to this project/codebase

0 commit comments

Comments
 (0)