Merge branch 'buffer-in-docs' of https://github.com/benwiley4000/imag…

…e-to-ascii into new-version
IonicaBizau · Dec 23, 2017 · a33dbd1 · a33dbd1
2 parents b9adfc4 + 3afa2fd
commit a33dbd1
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
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:
  *