Dependency on fs module removed (#171)

.travis.yml

@@ -9,6 +9,6 @@ after_success:
 
 language: node_js
 node_js:
-  - "4"
   - "6"
   - "8"
+  - "10"

CHANGELOG.md

@@ -1,5 +1,42 @@
 # Changelog
 
+## Version 5.0.0
+
+### BREAKING CHANGES
+
+#### fromFile removed
+
+The function `fromFile` is removed. It was the main reason `html-to-text` could not be used in the browser [#164](https://github.com/werk85/node-html-to-text/pull/164).
+
+You can get the `fromFile` functionality back by using the following code
+
+```js
+const fs = require('fs');
+const { fromString } = require('html-to-text');
+
+// Callback version
+const fromFile = (file, options, callback) => {
+  if (!callback) {
+    callback = options;
+    options = {};
+  }
+  fs.readFile(file, 'utf8', (err, str) => {
+    if (err) return callback(err);
+    callback(null, fromString(str, options));
+  });
+};
+
+// Promise version
+const fromFile = (file, option) => fs.promises.readFile(file, 'utf8').then(html => fromString(html, options));
+
+// Sync version
+const fromFileSync = (file, options) => fromString(fs.readFileSync(file, 'utf8'), options);
+```
+
+#### Supported NodeJS Versions
+Node versions < 6 are no longer supported.
+
+
 ## Version 4.0.0
 
 * Support dropped for node version < 4.

README.md

@@ -27,28 +27,14 @@ npm install html-to-text -g
 ```
 
 ## Usage
-You can read from a file via:
 
-```javascript
-var htmlToText = require('html-to-text');
-
-htmlToText.fromFile(path.join(__dirname, 'test.html'), {
-  tables: ['#invoice', '.address']
-}, (err, text) => {
-  if (err) return console.error(err);
-  console.log(text);
-});
-```
-
-or directly from a string:
-
-```javascript
-var htmlToText = require('html-to-text');
+```js
+const htmlToText = require('html-to-text');
 
-var text = htmlToText.fromString('<h1>Hello World</h1>', {
+const text = htmlToText.fromString('<h1>Hello World</h1>', {
   wordwrap: 130
 });
-console.log(text);
+console.log(text); // Hello World
 ```
 
 ### Options:

lib/html-to-text.js

@@ -1,6 +1,3 @@
-var fs = require('fs');
-var util = require('util');
-
 var includes = require('lodash/includes');
 var trimEnd = require('lodash/trimEnd');
 var htmlparser = require('htmlparser2');
@@ -186,17 +183,6 @@ function walk(dom, options, result) {
   return result;
 }
 
-exports.fromFile = function(file, options, callback) {
-  if (!callback) {
-    callback = options;
-    options = {};
-  }
-  fs.readFile(file, 'utf8', function (err, str) {
-    if (err) return callback(err);
-    return callback(null, htmlToText(str, options));
-  });
-};
-
 exports.fromString = function(str, options) {
   return htmlToText(str, options || {});
 };