📕 - add pnpm to README

soixantecircuits · Mar 19, 2022 · ee60554 · ee60554
1 parent 357dccd
commit ee60554
Showing 1 changed file with 24 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -2,18 +2,22 @@
 
 ## Installation
 
-`npm install media-helper --save` ⚡️  `yarn add media-helper`
+🤌 `pnpm add media-helper`
+
+📦 `npm install media-helper --save`
+
+⚡️ `yarn add media-helper`
 
 ## Usage
 
 ```js
 const mh = require('media-helper')
 
-const path = "/path/to/image.jpg"
-const url = "http://somesite.com/img.jpg"
+const path = '/path/to/image.jpg'
+const url = 'http://somesite.com/img.jpg'
 
 if (mh.isFile(path)) {
-  console.log(path, " is an existing file !")
+  console.log(path, ' is an existing file !')
 
   mh.toBase64(path)
     .then((data) => {
@@ -25,32 +29,31 @@ if (mh.isFile(path)) {
 }
 
 if (mh.isURL(url)) {
-  console.log(url, " is an URL !")
+  console.log(url, ' is an URL !')
 
   mh.toBase64(url)
-    .then(data => {
+    .then((data) => {
       // data is the base64 datas for the image
     })
     .catch((err) => {
       console.log(err)
     })
 }
-
 ```
 
 ## API
 
-|method|parameters|returns|description|
-|:---|:---:|:---:|:---|
-|`isBase64`| `string` | `boolean` |Determines if a string is base64 encoded.|
-|`isFile`| `path` | `boolean` |Determines if a string describes a path to an existing file on your system.|
-|`isURL`| `url` | `boolean` |Determines if a string describes an HTTP URL.|
-|`isBuffer`| `Buffer` | `boolean` |Determines if an object is a `Buffer`.|
-|`getMimeType`| `path` | `Promise` |Determines the mime-type of a file on your system.|
-|`isImage`| `path` | `Promise` |Determines if a file is an image.|
-|`isVideo`| `path` | `Promise` |Determines if a file is a video.|
-|`toBuffer`| `string` | `Promise` |Converts an image to Buffer. `string` can describe either a path, base64 datas or an url.|
-|`toBase64`| `string` | `Promise` |Converts an image to base64. `string` can describe either a path or an url.|
-|`urlToBase64`| `url` | `Promise` |Converts an image to base64 through an URL.|
-|`fileToBase64`| `path` | `Promise` |Converts an image on your system to base64.|
-|`trimDataURI`| `dataURL` | `base64 string` |Returns a base64 string without the dataURI scheme ("data;mime/type;base64,")|
+| method         | parameters |     returns     | description                                                                               |
+| :------------- | :--------: | :-------------: | :---------------------------------------------------------------------------------------- |
+| `isBase64`     |  `string`  |    `boolean`    | Determines if a string is base64 encoded.                                                 |
+| `isFile`       |   `path`   |    `boolean`    | Determines if a string describes a path to an existing file on your system.               |
+| `isURL`        |   `url`    |    `boolean`    | Determines if a string describes an HTTP URL.                                             |
+| `isBuffer`     |  `Buffer`  |    `boolean`    | Determines if an object is a `Buffer`.                                                    |
+| `getMimeType`  |   `path`   |    `Promise`    | Determines the mime-type of a file on your system.                                        |
+| `isImage`      |   `path`   |    `Promise`    | Determines if a file is an image.                                                         |
+| `isVideo`      |   `path`   |    `Promise`    | Determines if a file is a video.                                                          |
+| `toBuffer`     |  `string`  |    `Promise`    | Converts an image to Buffer. `string` can describe either a path, base64 datas or an url. |
+| `toBase64`     |  `string`  |    `Promise`    | Converts an image to base64. `string` can describe either a path or an url.               |
+| `urlToBase64`  |   `url`    |    `Promise`    | Converts an image to base64 through an URL.                                               |
+| `fileToBase64` |   `path`   |    `Promise`    | Converts an image on your system to base64.                                               |
+| `trimDataURI`  | `dataURL`  | `base64 string` | Returns a base64 string without the dataURI scheme ("data;mime/type;base64,")             |