timw4mail
/
HummingBirdAnimeClient
1
1
Fork 1
Code Issues 5 Pull Requests Projects 1 Releases Wiki Activity

Update README and composer

This commit is contained in:
Timothy Warren 2015-11-18 16:03:40 -05:00
parent 3b876f2c42
commit 7d1c8c383c
2 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -2,10 +2,10 @@
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)
[[Hosted Example](https://anime.timshomepage.net)]
[[Hosted Example](https://list.timshomepage.net)]
## Features
@ -14,9 +14,9 @@ A self-hosted client that allows custom formatting of data from the hummingbird
* Plan to Watch
* On Hold
* Dropped
* Completed
* Completed
* All of the above
* Manga List views (Each with list and cover views):
* Reading
* Plan to Read
@ -24,11 +24,11 @@ A self-hosted client that allows custom formatting of data from the hummingbird
* Dropped
* Completed
* All of the above
* Anime collection view (segmented by media type):
* Cover Images
* Table List
### Requirements
* PHP 5.5+
@ -48,12 +48,11 @@ A self-hosted client that allows custom formatting of data from the hummingbird
#### Anime Collection Additional Installation
* Run `php /vendor/bin/phinx migrate -e development` to create the database tables
* For importing anime:
1. Login
2. Use the form to select your media
1. Login
2. Use the form to select your media
3. Save & Repeat as needed
* 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=`
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

1
composer.json
View File

@ -14,6 +14,7 @@
"filp/whoops": "dev-php7#fe32a402b086b21360e82013e8a0355575c7c6f4",
"guzzlehttp/guzzle": "6.*",
"monolog/monolog": "1.*",
"mustache/mustache": "*",
"psr/log": "~1.0",
"robmorgan/phinx": "0.4.*",
"szymach/c-pchart": "1.*"