[1.1.0] Bump to version 1.1.0 and update README to reflect

README.md

@@ -11,7 +11,7 @@ Pull requests are welcome if you'd like to refactor parts (or all!) of the appli
 Requires [node.js/npm](https://nodejs.org/).
 
 - `npm install -g yiff-dl`
-- `yiff-dl 123456 -o /home/marcus/media/stuff/output/folder/here`
+- [See "Basic usage"](#basic-usage)
 
 ### Manual installation
 
@@ -24,19 +24,31 @@ Cloning from git and 'manually' using the project.
 
 ## Basic usage
 
+As of **version 1.1.0**, yiff-dl can now download creator media based on their Patreon/creator name.
+
+1. Navigate to the directory you want to download to (example: `cd /home/marcus/Downloads/Patreon`)
+2. Download using `yiff-dl <creator_name>` (example: `yiff-dl Marcus`).
+    - By default downloads into `yiff-dl-output`, see [Parameters](#parameters) on how to override.
+3. Wait.
+
+### Alternative
+
+If for some reason the first method didn't work, you can use the alternative method which relies on Yiff's creator ID.  
+This is basically the same method as the one used prior to version 1.1.0.
+
 1. Find the creator ID of the creator you want to download from. If the URL is `https://yiff.party/patreon/123456`, then `123456` is the creator ID.
 2. Navigate to the directory you want to download to (example: `cd /home/marcus/Downloads/Patreon`)
 3. Download using `yiff-dl <creator_id>` (example: `yiff-dl 123456`).
-    - Optional: Use `-o Creator_Name` to create a folder for that specific creator (default folder name is `yiff-dl-output`).
-    - Example: `yiff-dl 123456 -o Creator_Name` will create a folder called `Creator_Name` with all the data inside.
+    - By default downloads into `yiff-dl-output`, see [Parameters](#parameters) on how to override.
 4. Wait.
 
-See [Parameters](#parameters) for more advanced options.
-
 ## Parameters
 
-- `--user-agent` - Specifies a custom user agent - Default (as of 1.0.3): `Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:69.0) Gecko/20100101 Firefox/69.0`
-- `--output, -o` - Specifies a custom output folder - Default: Folder named `yiff-dl-output` in the current working directory, for example: `/data/projects/yiff-dl/yiff-dl-output`
+yiff-dl allows for some customization using more advanced parameters.
+
+- `--output, -o $outputFolder` - Specifies a custom output folder - Default: Folder named `yiff-dl-output` in the current working directory, for example: `/data/projects/yiff-dl/yiff-dl-output`
+- `--subfolder, -s` - If specified, a subfolder with the creator name is created in the output directory. Example: `/data/projects/yiff-dl/yiff-dl-output/marcus`
+- `--user-agent $userAgent` - Specifies a custom user agent - Default (as of 1.0.3): `Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:69.0) Gecko/20100101 Firefox/69.0`
 
 ## Notes
 

package.json

@@ -1,6 +1,6 @@
 {
     "name": "yiff-dl",
-    "version": "1.0.3",
+    "version": "1.1.0",
     "description": "Downloads files from creators on Yiff",
     "main": "index.js",
     "scripts": {
@@ -19,7 +19,7 @@
     "dependencies": {
         "axios": "^0.19.0",
         "filenamify": "^4.1.0",
-        "jsdom": "^15.2.0",
+        "jsdom": "^15.2.1",
         "meow": "^5.0.0",
         "node-html-parser": "^1.1.16",
         "progress": "^2.0.3",