Merge branch 'buffer-in-docs' of https://github.com/benwiley4000/image-to-ascii into new-version

IonicaBizau · IonicaBizau · commit a33dbd1e1944 · 2017-12-23T20:55:12.000+02:00
diff --git a/README.md b/README.md
@@ -80,7 +80,7 @@ Converts the provided image in ASCII art.
 
 #### Params
 
-- **String** `source`: The path/url to the image.
+- **String|Buffer** `source`: The path/url to the image or a `Buffer` object.
 - **Object|String** `options`: The path to the image or an object containing the following fields:
 
  **Size Options**:
diff --git a/lib/index.js b/lib/index.js
@@ -29,7 +29,7 @@ const DEFAULTS = {
  *
  * @name imageToAscii
  * @function
- * @param {String} source The path/url to the image.
+ * @param {String|Buffer} source The path/url to the image or a Buffer object.
  * @param {Object|String} options The path to the image or an object containing
  * the following fields:
  *

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ const DEFAULTS = {`
`29`	`29`	`*`
`30`	`30`	`* @name imageToAscii`
`31`	`31`	`* @function`
`32`		`- * @param {String} source The path/url to the image.`
	`32`	`+ * @param {String\|Buffer} source The path/url to the image or a Buffer object.`
`33`	`33`	`* @param {Object\|String} options The path to the image or an object containing`
`34`	`34`	`* the following fields:`
`35`	`35`	`*`