Browse Source

Update README.md

Godzil 7 years ago
parent
commit
14260d04b3
1 changed files with 7 additions and 5 deletions
  1. 7 5
      README.md

+ 7 - 5
README.md

@@ -1,6 +1,6 @@
-# CrunchyRoll.js
+# Crunchy.js: a fork of Deathspike/CrunchyRoll.js
 
 
-*CrunchyRoll.js* is capable of downloading *anime* episodes from the popular *CrunchyRoll* streaming service. An episode is stored in the original video format (often H.264 in a MP4 container) and the configured subtitle format (ASS or SRT).The two output files are then merged into a single MKV file.
+*Crunchy.js* is capable of downloading *anime* episodes from the popular *CrunchyRoll* streaming service. An episode is stored in the original video format (often H.264 in a MP4 container) and the configured subtitle format (ASS or SRT).The two output files are then merged into a single MKV file.
 
 
 ## Motivation
 ## Motivation
 
 
@@ -10,6 +10,8 @@
 
 
 This application is not endorsed or affliated with *CrunchyRoll*. The usage of this application enables episodes to be downloaded 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.
 This application is not endorsed or affliated with *CrunchyRoll*. The usage of this application enables episodes to be downloaded 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.
 
 
+**PLEASE USE THIS TOOL ONLY IF YOU HAVE A PREMIUM ACCOUNT**
+
 ## Configuration
 ## Configuration
 
 
 It is recommended to enable authentication (`-p` and `-u`) so your account permissions and settings are available for use. It is not possible to download non-free material without an account and premium subscription. Furthermore, the default account settings are used when downloading. If you want the highest quality videos, configure these preferences at https://www.crunchyroll.com/acct/?action=video.
 It is recommended to enable authentication (`-p` and `-u`) so your account permissions and settings are available for use. It is not possible to download non-free material without an account and premium subscription. Furthermore, the default account settings are used when downloading. If you want the highest quality videos, configure these preferences at https://www.crunchyroll.com/acct/?action=video.
@@ -28,18 +30,18 @@ Use the applicable instructions to install. Is your operating system not listed?
 
 
 1. Run in *Terminal*: `sudo apt-get install nodejs npm mkvtoolnix rtmpdump ffmpeg`
 1. Run in *Terminal*: `sudo apt-get install nodejs npm mkvtoolnix rtmpdump ffmpeg`
 2. Run in *Terminal*: `sudo ln -s /usr/bin/nodejs /usr/bin/node`
 2. Run in *Terminal*: `sudo ln -s /usr/bin/nodejs /usr/bin/node`
-3. Run in *Terminal*: `sudo npm install -g crunchyroll`
+3. Run in *Terminal*: `sudo npm install -g godzil/crunchyroll.js`
 
 
 ### Mac OS X
 ### Mac OS X
 
 
 1. Install *Homebrew* following the instructions at http://brew.sh/
 1. Install *Homebrew* following the instructions at http://brew.sh/
 2. Run in *Terminal*: `brew install node mkvtoolnix rtmpdump ffmpeg`
 2. Run in *Terminal*: `brew install node mkvtoolnix rtmpdump ffmpeg`
-3. Run in *Terminal*: `npm install -g crunchyroll`
+3. Run in *Terminal*: `npm install -g godzil/crunchyroll.js`
 
 
 ### Windows
 ### Windows
 
 
 1. Install *NodeJS* following the instructions at http://nodejs.org/
 1. Install *NodeJS* following the instructions at http://nodejs.org/
-3. Run in *Command Prompt*: `npm install -g crunchyroll`
+3. Run in *Command Prompt*: `npm install -g godzil/crunchyroll.js`
 
 
 ## Instructions
 ## Instructions