Update README and composer
This commit is contained in:
parent
99b429433c
commit
52397bbd61
17
README.md
17
README.md
@ -2,10 +2,10 @@
|
|||||||
|
|
||||||
A self-hosted client that allows custom formatting of data from the hummingbird api
|
A self-hosted client that allows custom formatting of data from the hummingbird api
|
||||||
|
|
||||||
[![Build Status](https://travis-ci.org/timw4mail/HummingBirdAnimeClient.svg)](https://travis-ci.org/timw4mail/HummingBirdAnimeClient)
|
[![Build Status](https://jenkins.timshomepage.net/buildStatus/icon?job=animeclient)](https://jenkins.timshomepage.net/job/animeclient/)
|
||||||
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/timw4mail/HummingBirdAnimeClient/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/timw4mail/HummingBirdAnimeClient/?branch=master)
|
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/timw4mail/HummingBirdAnimeClient/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/timw4mail/HummingBirdAnimeClient/?branch=master)
|
||||||
|
|
||||||
[[Hosted Example](https://anime.timshomepage.net)]
|
[[Hosted Example](https://list.timshomepage.net)]
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
@ -14,9 +14,9 @@ A self-hosted client that allows custom formatting of data from the hummingbird
|
|||||||
* Plan to Watch
|
* Plan to Watch
|
||||||
* On Hold
|
* On Hold
|
||||||
* Dropped
|
* Dropped
|
||||||
* Completed
|
* Completed
|
||||||
* All of the above
|
* All of the above
|
||||||
|
|
||||||
* Manga List views (Each with list and cover views):
|
* Manga List views (Each with list and cover views):
|
||||||
* Reading
|
* Reading
|
||||||
* Plan to Read
|
* Plan to Read
|
||||||
@ -24,11 +24,11 @@ A self-hosted client that allows custom formatting of data from the hummingbird
|
|||||||
* Dropped
|
* Dropped
|
||||||
* Completed
|
* Completed
|
||||||
* All of the above
|
* All of the above
|
||||||
|
|
||||||
* Anime collection view (segmented by media type):
|
* Anime collection view (segmented by media type):
|
||||||
* Cover Images
|
* Cover Images
|
||||||
* Table List
|
* Table List
|
||||||
|
|
||||||
### Requirements
|
### Requirements
|
||||||
|
|
||||||
* PHP 5.5+
|
* PHP 5.5+
|
||||||
@ -48,12 +48,11 @@ A self-hosted client that allows custom formatting of data from the hummingbird
|
|||||||
#### Anime Collection Additional Installation
|
#### Anime Collection Additional Installation
|
||||||
* Run `php /vendor/bin/phinx migrate -e development` to create the database tables
|
* Run `php /vendor/bin/phinx migrate -e development` to create the database tables
|
||||||
* For importing anime:
|
* For importing anime:
|
||||||
1. Login
|
1. Login
|
||||||
2. Use the form to select your media
|
2. Use the form to select your media
|
||||||
3. Save & Repeat as needed
|
3. Save & Repeat as needed
|
||||||
* For bulk importing anime:
|
* For bulk importing anime:
|
||||||
1. Find the anime you are looking for on the hummingbird search api page: `https://hummingbird.me/api/v1/search/anime?query=`
|
1. Find the anime you are looking for on the hummingbird search api page: `https://hummingbird.me/api/v1/search/anime?query=`
|
||||||
2. Create an `import.json` file in the root of the app, with an array of objects from the search page that you want to import
|
2. Create an `import.json` file in the root of the app, with an array of objects from the search page that you want to import
|
||||||
3. Go to the anime collection tab, and the import will be run
|
3. Go to the anime collection tab, and the import will be run
|
||||||
|
|
||||||
|
|
@ -14,6 +14,7 @@
|
|||||||
"filp/whoops": "dev-php7#fe32a402b086b21360e82013e8a0355575c7c6f4",
|
"filp/whoops": "dev-php7#fe32a402b086b21360e82013e8a0355575c7c6f4",
|
||||||
"guzzlehttp/guzzle": "6.*",
|
"guzzlehttp/guzzle": "6.*",
|
||||||
"monolog/monolog": "1.*",
|
"monolog/monolog": "1.*",
|
||||||
|
"mustache/mustache": "*",
|
||||||
"psr/log": "~1.0",
|
"psr/log": "~1.0",
|
||||||
"robmorgan/phinx": "0.4.*",
|
"robmorgan/phinx": "0.4.*",
|
||||||
"szymach/c-pchart": "1.*"
|
"szymach/c-pchart": "1.*"
|
||||||
|
Loading…
Reference in New Issue
Block a user