Merge branch 'master' of https://github.com/gildas-lormeau/SingleFile

.github/ISSUE_TEMPLATE/feature_request.md

@@ -10,8 +10,8 @@ A clear and concise description of what the problem is. Ex. I'm always frustrate
 **Describe the solution you'd like**
 A clear and concise description of what you want to happen.
 
-**Describe alternatives you've considered**
+**Describe alternatives you've considered (optional)**
 A clear and concise description of any alternative solutions or features you've considered.
 
-**Additional context**
+**Additional context (optional)**
 Add any other context or screenshots about the feature request here.

README.MD

@@ -8,6 +8,7 @@ SingleFile is a WebExtension compatible with Chrome, Firefox (Desktop and Mobile
  - [Additional notes](#additional-notes)
  - [More info](#more-info)
  - [Statistics (Firefox)](#statistics-firefox)
+ - [Command Line Interface](#command-line-interface)
  - [Known issues](#known-issues)
  - [Troubleshooting unknown issues](#troubleshooting-unknown-issues)
  - [Contributors](#contributors)
@@ -52,6 +53,9 @@ See the extension help in the options page for more detailed information about t
 ## Statistics (Firefox)
 See https://addons.mozilla.org/en-US/firefox/addon/single-file/statistics/?last=90
 
+## Command Line Interface
+See https://github.com/gildas-lormeau/SingleFile/blob/master/cli/README.MD
+
 ## Known Issues
 - All browsers:
   - For security reasons, you cannot save pages hosted on https://chrome.google.com or https://addons.mozilla.org.

cli/README.MD

@@ -1,25 +1,20 @@
-# SingleFile (command-line mode)
+# SingleFile (Command Line Interface)
 
 ## Introduction
 
-SingleFile can be launched from the command line by running it into a (headless) browser. 
-
-It supports:
-
-- [Puppeteer](https://github.com/GoogleChrome/puppeteer)
-- [Selenium WebDriver](https://www.npmjs.com/package/selenium-webdriver)
-- [jsdom](https://github.com/jsdom/jsdom)
+SingleFile can be launched from the command line by running it into a (headless) browser. It runs through Node.js as a standalone script injected into the page to save instead of being embedded into a WebExtension. To connect to the browser, it can use [Puppeteer](https://github.com/GoogleChrome/puppeteer) or [Selenium WebDriver](https://www.npmjs.com/package/selenium-webdriver). Alternatively, it can also emulate a browser with JavaScript disabled by using [jsdom](https://github.com/jsdom/jsdom).
 
 This is a **work in progress**.
 
-# Run SingleFile
+## Run SingleFile
 
-## Prerequisites
-- [Chrome/Chromium](https://www.google.com/chrome/) and [Node.js](https://nodejs.org) must be installed first. It is recommended that Chrome/Chromium executable can be found through the `PATH` environment variable. Otherwise you will need to use the `--browser-executable-path` option to help SingleFile locating the executable.
-- By default SingleFile will use Puppeteer to connect to the browser. If you want to use Selenium WebDriver instead, you must install it first and ensure the executable can be found through the `PATH` environment variable.
+### Prerequisites
 
-## Install
-- Unzip the [master archive](https://github.com/gildas-lormeau/SingleFile/archive/master.zip) somewhere on your disk.
+- [Node.js](https://nodejs.org) must be installed first. To use Puppeteer or Selenium WebDriver, [Chrome/Chromium](https://www.google.com/chrome/) must also be installed. It is recommended that Chrome/Chromium executable can be found through the `PATH` environment variable. Otherwise you will need to add the `--browser-executable-path` option to help SingleFile locating the executable.
+- By default SingleFile will use Puppeteer to connect to the browser. If you prefer Selenium WebDriver, you must install it first and ensure the executable can be found through the `PATH` environment variable.
+
+### Install
+- Unzip the [master archive](https://github.com/gildas-lormeau/SingleFile/archive/master.zip) somewhere on your disk in an empty folder.
 
   `$ unzip master.zip .`
   
@@ -31,20 +26,28 @@ This is a **work in progress**.
 
   `$ npm install`
   
-- Make `single-file.js` executable (Linux/Unix).
+- Make `single-file.js` executable (Linux/Unix/BSD etc.).
 
   `$ chmod +x single-file.js`
 
-## Run
+### Run
 - Display help
 
-  `$ ./single-file.js --help` (Linux/Unix)
+  `$ ./single-file.js --help` (Linux/Unix/BSD etc.)
 
   `> node single-file.js --help` (Windows)
   
 - Saving https://www.wikipedia.org into `wikipedia.html`
 
-  `$ ./single-file.js https://www.wikipedia.org wikipedia.html` (Linux/Unix)
+  `$ ./single-file.js https://www.wikipedia.org wikipedia.html` (Linux/Unix/BSD etc.)
   
   `> node single-file.js https://www.wikipedia.org wikipedia.html` (Windows)
- 
+
+- Saving https://www.wikipedia.org into `wikipedia.html` with jsdom instead of Puppeteer
+
+  `$ ./single-file.js https://www.wikipedia.org wikipedia.html --back-end=jsdom` (Linux/Unix/BSD etc.)
+  
+  `> node single-file.js https://www.wikipedia.org wikipedia.html --back-end=jsdom` (Windows)
+  
+## License
+SingleFile is licensed under AGPL and GPL. Code derived from third-party projects is licensed under MIT. Please contact me at gildas.lormeau <at> gmail.com if you are interested in licensing the SingleFile code for a commercial service or product.