From 772634c0f7319972367c18f5807d7552e366322c Mon Sep 17 00:00:00 2001 From: Belar Date: Fri, 1 Nov 2024 12:06:50 +0000 Subject: [PATCH 1/2] build: update penpot to v1 --- package-lock.json | 16 ++++++++-------- package.json | 4 ++-- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/package-lock.json b/package-lock.json index 0bd8032..847af53 100644 --- a/package-lock.json +++ b/package-lock.json @@ -10,7 +10,7 @@ "dependencies": { "@coreui/icons": "^3.0.1", "@material-design-icons/svg": "^0.14.13", - "@penpot/plugin-styles": "^0.12.0", + "@penpot/plugin-styles": "^1.0.0", "@phosphor-icons/core": "^2.1.1", "@tabler/icons": "^3.19.0", "bootstrap-icons": "^1.11.3", @@ -25,7 +25,7 @@ }, "devDependencies": { "@eslint/js": "^9.9.0", - "@penpot/plugin-types": "^0.12.0", + "@penpot/plugin-types": "^1.0.0", "@playwright/test": "^1.47.2", "@types/node": "^22.7.2", "@types/react": "^18.3.9", @@ -669,14 +669,14 @@ } }, "node_modules/@penpot/plugin-styles": { - "version": "0.12.0", - "resolved": "https://registry.npmjs.org/@penpot/plugin-styles/-/plugin-styles-0.12.0.tgz", - "integrity": "sha512-VZ5SUrLyl0/0rZtnNCxlfTXsXRT6r+LuA+17jQ5gb+3bq2VMq2HAn0OMm0VhcBifDfKw3bds0xv1+IZUODMAxw==" + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/@penpot/plugin-styles/-/plugin-styles-1.0.0.tgz", + "integrity": "sha512-LLvDZ2b6uqc0PvqDD530kqev8RXfQ06oNdJA5RMgBwDM+XqUpMmvwtvkAKtmrJyKXOL2jZll0EW1CyyCAMm7uw==" }, "node_modules/@penpot/plugin-types": { - "version": "0.12.0", - "resolved": "https://registry.npmjs.org/@penpot/plugin-types/-/plugin-types-0.12.0.tgz", - "integrity": "sha512-rtSJ8memBAWxRBEx+S47NFDJN5VIvY0J7QzwTBer45Ls3BjLCaWXCnfFEcRn4SzY+Th01tmop0pwdvN5YDxkBw==", + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/@penpot/plugin-types/-/plugin-types-1.0.0.tgz", + "integrity": "sha512-xvBckpjyLVKbTJ2ZsBWZskuWpDlnJONuQ/SeF/g0PLKTkLudCfO56RT0KeAhesxzfZoewu194/S2CHaZHoRjKQ==", "dev": true }, "node_modules/@phosphor-icons/core": { diff --git a/package.json b/package.json index 26b2131..17a274e 100644 --- a/package.json +++ b/package.json @@ -15,7 +15,7 @@ "dependencies": { "@coreui/icons": "^3.0.1", "@material-design-icons/svg": "^0.14.13", - "@penpot/plugin-styles": "^0.12.0", + "@penpot/plugin-styles": "^1.0.0", "@phosphor-icons/core": "^2.1.1", "@tabler/icons": "^3.19.0", "bootstrap-icons": "^1.11.3", @@ -30,7 +30,7 @@ }, "devDependencies": { "@eslint/js": "^9.9.0", - "@penpot/plugin-types": "^0.12.0", + "@penpot/plugin-types": "^1.0.0", "@playwright/test": "^1.47.2", "@types/node": "^22.7.2", "@types/react": "^18.3.9", From bef564349d2b1c2c5518ccde95acffbefae21294 Mon Sep 17 00:00:00 2001 From: Belar Date: Fri, 1 Nov 2024 13:01:43 +0000 Subject: [PATCH 2/2] docs: add installation link steps --- README.md | 27 +++++++++++++++++++-------- 1 file changed, 19 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index d7033aa..1d7d1e7 100644 --- a/README.md +++ b/README.md @@ -8,20 +8,31 @@ All Icons is a Penpot plugin that allows you to easily access icons from various ## Installation -> Penpot Plugins system is currently in development and not yet available in the live Penpot release. +### Penpot App +1. Sign in to Penpot (the official SaaS version). +1. Trigger the installation of the plugin by following the link below: + [Install All Icons plugin](https://design.penpot.app/#?plugin=https://allicons.authormore.com/manifest.json) +1. Follow the instructions on the screen. + The installer will inform you about the permissions requested by the plugin: + - Content's write access is necessary for the icon insertion. + - Content's read access is necessary to save and retrieve the plugin's settings e.g. open icon sets, selected style variants. 1. Go to a Penpot project. -2. Open the plugin manager. -3. Fill the plugin URL input with `https://allicons.authormore.com/manifest.json`. -4. Click the "Install" button. -5. Follow the instructions on the screen. +1. Open the plugin through the plugin manager. - The installer will inform you about the permissions requested by the plugin: +> **Note**: If you manage a self-hosted Penpot instance, you can create an All Icons installation link by using the following pattern `/#?plugin=https://allicons.authormore.com/manifest.json` where `` is the URL of your Penpot instance. +### Manual + +1. Go to a Penpot project. +1. Open the plugin manager. +1. Fill the plugin URL input with `https://allicons.authormore.com/manifest.json`. +1. Click the "Install" button. +1. Follow the instructions on the screen. + The installer will inform you about the permissions requested by the plugin: - Content's write access is necessary for the icon insertion. - Content's read access is necessary to save and retrieve the plugin's settings e.g. open icon sets, selected style variants. - -6. Use the plugin manager to open the plugin. +1. Use the plugin manager to open the plugin. ## Development