Updated README.md

This commit is contained in:
Roel van Uden 2015-01-23 00:50:17 +01:00
parent f15d1e77e9
commit 2d9d8a1961

View File

@ -1,22 +1,29 @@
# CrunchyRoll.js # CrunchyRoll.js
CrunchyRoll.js is capable of downloading anime from the popular CrunchyRoll *CrunchyRoll.js* is capable of saving *anime* episodes from the popular *CrunchyRoll*
streaming site. Each episode is stored with the original video encoding streaming service. An episode is stored in the original video format (often
(usually H.264, MP4) and the configured subtitle format (ASS or SRT). The two H.264 in a MP4 container) and the configured subtitle format (ASS or SRT). The
output files can optionally be muxed into a single MKV file. two output files are optionally muxed into a single MKV file.
## Motivation ## Motivation
I **love** *CrunchyRoll*. They have been working hard to provide an amazing service to *CrunchyRoll* has been providing an amazing streaming service and offers the
*anime* fans and provide the *absolute best* way to watch *anime* series in a legal best way to enjoy *anime* in a *convenient* and *legal* way. As a streaming
way. As they offer a streaming service, they do not offer files to be downloaded service, video files cannot be saved and watched offline. Understandable from a
and enjoyed while offline (or travelling). This is understandable from a business perspective and considering the contract implications, but annoying for
business perspective, but extremely annoying for the end-user. I put this users. This application enables episodes to be saved for offline convenience.
application together to enable the files to be stored and enjoyed while offline. Please do not abuse this application; save episodes for **personal use** and
Please do not download as much as you can and stop your premium subscription; **delete them** if you do not have an active premium account. Continue to support
without our financial support, they cannot give us such as great service! *CrunchyRoll*; without our financial backing their service cannot exist!
**Do not share downloaded files and delete them if you ever stop your
premium subscription!** ## Legal Warning
This application is not endorsed or affliated with *CrunchyRoll*. The usage of
this application enables episodes to be saved for offline convenience which may
be forbidden by law in your country. Usage of this application may also cause a
violation of the agreed *Terms of Service* between you and the stream provider.
A tool is not responsible for your actions; please make an informed decision
prior to using this application.
## Status ## Status
@ -31,8 +38,8 @@ premium subscription!**
* Add ASS support. * Add ASS support.
* Add muxing (MP4+ASS=MKV). * Add muxing (MP4+ASS=MKV).
* Add series API to download an entire series rather than per-episode. * Add series API to save an entire series rather than per-episode.
* Add batch-mode to queue a bunch of series and do incremental downloads. * Add batch-mode to queue a bunch of series and do incremental saves.
* Add authentication to the entire stack to support premium content. * Add authentication to the entire stack to support premium content.
* Add CLI interface with all the options. * Add CLI interface with all the options.
* Enjoy beautiful anime series from disk when internet is down. * Enjoy beautiful anime series from disk when internet is down.