From 81ed59e9bce45f5cb12c4afb4b55573e13d60db8 Mon Sep 17 00:00:00 2001 From: Marcus Date: Thu, 7 Nov 2019 20:09:22 +0100 Subject: [PATCH] [1.1.0] Bump to version 1.1.0 and update README to reflect --- README.md | 26 +++++++++++++++++------- package-lock.json | 50 +++++++++++++++++++++++------------------------ package.json | 4 ++-- 3 files changed, 46 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 974e365..510e346 100644 --- a/README.md +++ b/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 ` (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 ` (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 diff --git a/package-lock.json b/package-lock.json index e23e007..d47ce4c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "yiff-dl", - "version": "1.0.3", + "version": "1.1.0", "lockfileVersion": 1, "requires": true, "dependencies": { @@ -510,9 +510,9 @@ "integrity": "sha1-peZUwuWi3rXyAdls77yoDA7y9RM=" }, "jsdom": { - "version": "15.2.0", - "resolved": "https://registry.npmjs.org/jsdom/-/jsdom-15.2.0.tgz", - "integrity": "sha512-+hRyEfjRPFwTYMmSQ3/f7U9nP8ZNZmbkmUek760ZpxnCPWJIhaaLRuUSvpJ36fZKCGENxLwxClzwpOpnXNfChQ==", + "version": "15.2.1", + "resolved": "https://registry.npmjs.org/jsdom/-/jsdom-15.2.1.tgz", + "integrity": "sha512-fAl1W0/7T2G5vURSyxBzrJ1LSdQn6Tr5UX/xD4PXDx/PDgwygedfW6El/KIj3xJ7FU61TTYnc/l/B7P49Eqt6g==", "requires": { "abab": "^2.0.0", "acorn": "^7.1.0", @@ -524,7 +524,7 @@ "domexception": "^1.0.1", "escodegen": "^1.11.1", "html-encoding-sniffer": "^1.0.2", - "nwsapi": "^2.1.4", + "nwsapi": "^2.2.0", "parse5": "5.1.0", "pn": "^1.1.0", "request": "^2.88.0", @@ -689,9 +689,9 @@ } }, "nwsapi": { - "version": "2.1.4", - "resolved": "https://registry.npmjs.org/nwsapi/-/nwsapi-2.1.4.tgz", - "integrity": "sha512-iGfd9Y6SFdTNldEy2L0GUhcarIutFmk+MPWIn9dmj8NMIup03G08uUF2KGbbmv/Ux4RT0VZJoP/sVbWA6d/VIw==" + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/nwsapi/-/nwsapi-2.2.0.tgz", + "integrity": "sha512-h2AatdwYH+JHiZpv7pt/gSX1XoRGb7L/qSIeuqA6GwYoF9w1vP1cw42TO0aI2pNyshRK5893hNSl+1//vHK7hQ==" }, "oauth-sign": { "version": "0.9.0", @@ -699,16 +699,16 @@ "integrity": "sha512-fexhUFFPTGV8ybAtSIGbV6gOkSv8UtRbDBnAyLQw4QPKkgNlsH2ByPGtMUqdWkos6YCRmAqViwgZrJc/mRDzZQ==" }, "optionator": { - "version": "0.8.2", - "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.8.2.tgz", - "integrity": "sha1-NkxeQJ0/TWMB1sC0wFu6UBgK62Q=", + "version": "0.8.3", + "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.8.3.tgz", + "integrity": "sha512-+IW9pACdk3XWmmTXG8m3upGUJst5XRGzxMRjXzAuJ1XnIFNvfhjjIuYkDvysnPQ7qzqVzLt78BCruntqRhWQbA==", "requires": { "deep-is": "~0.1.3", - "fast-levenshtein": "~2.0.4", + "fast-levenshtein": "~2.0.6", "levn": "~0.3.0", "prelude-ls": "~1.1.2", "type-check": "~0.3.2", - "wordwrap": "~1.0.0" + "word-wrap": "~1.2.3" } }, "p-limit": { @@ -890,19 +890,19 @@ } }, "request-promise-core": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/request-promise-core/-/request-promise-core-1.1.2.tgz", - "integrity": "sha512-UHYyq1MO8GsefGEt7EprS8UrXsm1TxEvFUX1IMTuSLU2Rh7fTIdFtl8xD7JiEYiWU2dl+NYAjCTksTehQUxPag==", + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/request-promise-core/-/request-promise-core-1.1.3.tgz", + "integrity": "sha512-QIs2+ArIGQVp5ZYbWD5ZLCY29D5CfWizP8eWnm8FoGD1TX61veauETVQbrV60662V0oFBkrDOuaBI8XgtuyYAQ==", "requires": { - "lodash": "^4.17.11" + "lodash": "^4.17.15" } }, "request-promise-native": { - "version": "1.0.7", - "resolved": "https://registry.npmjs.org/request-promise-native/-/request-promise-native-1.0.7.tgz", - "integrity": "sha512-rIMnbBdgNViL37nZ1b3L/VfPOpSi0TqVDQPAvO6U14lMzOLrt5nilxCQqtDKhZeDiW0/hkCXGoQjhgJd/tCh6w==", + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/request-promise-native/-/request-promise-native-1.0.8.tgz", + "integrity": "sha512-dapwLGqkHtwL5AEbfenuzjTYg35Jd6KPytsC2/TLkVMz8rm+tNt72MGUWT1RP/aYawMpN6HqbNGBQaRcBtjQMQ==", "requires": { - "request-promise-core": "1.1.2", + "request-promise-core": "1.1.3", "stealthy-require": "^1.1.1", "tough-cookie": "^2.3.3" }, @@ -1180,10 +1180,10 @@ "webidl-conversions": "^4.0.2" } }, - "wordwrap": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz", - "integrity": "sha1-J1hIEIkUVqQXHI0CJkQa3pDLyus=" + "word-wrap": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.3.tgz", + "integrity": "sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ==" }, "ws": { "version": "7.2.0", diff --git a/package.json b/package.json index 48bd04a..f25988d 100644 --- a/package.json +++ b/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",