Skip to content

Commit 1e9435d

Browse files
committed
Update install and usage instructions
1 parent 64b222b commit 1e9435d

File tree

1 file changed

+29
-6
lines changed

1 file changed

+29
-6
lines changed

Diff for: README.md

+29-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# :musical_note: monstercat-dl
22

3-
Download Monstercat songs from your Terminal app! All the documentation you need is on the [monstercat-dl website](https://d9beuD.github.io/monstercat-dl).
3+
Download Monstercat songs from your Terminal app! All the documentation you need is on the [monstercat-dl website](https://d9beud.com/monstercat-dl/). This tool isn't affiliated with Monstercat.
44

55
## Table of contents
66

@@ -14,18 +14,41 @@ Download Monstercat songs from your Terminal app! All the documentation you need
1414
## Requirements
1515

1616
To get monstercat-dl working correctly, you will need this:
17-
- [wget](https://www.gnu.org/software/wget/) (on macOS `brew install wget`)\[optional, see warning below]
1817
- [php](https://php.net) >= 7.0
1918

20-
:warning: If you don't want to use `wget` and prefer `php` native functions, use `--without-get` argument.
21-
2219
## Installation
2320

24-
Read [installation](https://d9beuD.github.io/monstercat-dl/docs/v1.0/install.html) docs.
21+
For UNIX systems users (macOS and Linux), clone this repository and follow those steps:
22+
23+
1. `git clone https://github.com/d9beuD/monstercat-dl.git`
24+
2. `cd monstercat-dl`
25+
26+
Then you need to install the project's dependencies:
27+
28+
1. `composer install` (if you don't have [Composer](https://getcomposer.org) installed, read its [installation docs](https://getcomposer.org/doc/00-intro.md))
29+
30+
Finally, create the executable:
31+
32+
1. `php create-phar.php`
33+
2. `bash install.sh`
34+
35+
If you don't want to install this tool, you can still use the `.phar` file like so `php monstercat-dl.phar`.
2536

2637
## Usage
2738

28-
Read [usage](https://d9beuD.github.io/monstercat-dl/docs/v1.0/usage.html) docs.
39+
### Download tracks
40+
41+
Using this command is pretty simple as it doesn't need any option. All you have to do is to find the release ID at the end of the release page URL.
42+
43+
```
44+
monstercat-dl download <releases>...
45+
```
46+
47+
For example, if you want to download `https://www.monstercat.com/release/MCLP016` and `https://www.monstercat.com/release/MCEP215` write your command as below:
48+
49+
```
50+
monstercat-dl download MCLP016 MCEP215
51+
```
2952

3053
## Other (manual) methods
3154

0 commit comments

Comments
 (0)