@todesktop/client-get-app-icon - npm Package Compare versions

Comparing version 0.3.0 to 0.4.0

package.json

 {
   "name": "@todesktop/client-get-app-icon",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -1,14 +0,5 @@
-- [ToDesktop Client Get App Icon](#todesktop-client-get-app-icon)
-  - [Installation](#installation)
-  - [Usage](#usage)
-  - [Architecture](#architecture)
-  - [Development](#development)
+# ToDesktop Get App Icon
 
-# ToDesktop Client Get App Icon
+Retrieve the icon of a file or app.
 
-This is the repo for the [ToDesktop Get App Icon](https://github.com/ToDesktop/todesktop-get-app-icon) client.
-
-This is a zero-dependency package for interacting with [@todesktop/plugin-get-app-icon](https://www.npmjs.com/package/@todesktop/plugin-get-app-icon). This package exposes a function for getting the icon of a file or app.
-
-
 ## Installation
@@ -19,9 +10,11 @@
 ```sh
-$ npm install @todesktop/client-get-app-icon
+npm install @todesktop/client-get-app-icon
 ```
 
-Installation of the [plugin](https://www.npmjs.com/package/@todesktop/plugin-get-app-icon) package is also necessary.
+Installation of the [plugin](https://www.npmjs.com/package/@todesktop/plugin-get-app-icon) package is also necessary. Using ToDesktop Builder, navigate to **Plugins.** Click on the **Explore** button for "Get App Icon" and install the package.
 
 ## Usage
 
+### `extractIcon`
+
 Get the icon of a file or app as a PNG image.
@@ -34,15 +27,4 @@
   console.log(await extractIcon("path/to/icon"));
-	// data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAKsAAADV.....
+  // data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAKsAAADV.....
 })();
 ```
-
-## Architecture
-
-This package requires the following files:
-
-- `src/index.ts`: exposes plugin functionality through strongly-typed, easy-to-use functions.
-- `src/generated/plugin.d.ts`: automatically generated types from `@todesktop/plugin-get-app-icon`'s `index.ts` file.
-
-## Development
-
-Refer to the [root](https://github.com/ToDesktop/todesktop-get-app-icon) repo for development instructions.

No alert changes

Worsened metrics

Total package byte prevSize

3423

decreased by-35.32%

Number of package files

6

decreased by-25%

Lines of code

46

decreased by-50%

Number of lines in readme file

29

decreased by-36.96%

No dependency changes