Skip to content

Commit

Permalink
Merge pull request #22 from author-more/feat/live-update
Browse files Browse the repository at this point in the history
feat: match penpot plugins release
  • Loading branch information
Belar authored Nov 2, 2024
2 parents 0b8d7b3 + bef5643 commit 88d4da6
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 18 deletions.
27 changes: 19 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<penpot-instance-origin>/#?plugin=https://allicons.authormore.com/manifest.json` where `<penpot-instance-origin>` 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

Expand Down
16 changes: 8 additions & 8 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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",
Expand Down

0 comments on commit 88d4da6

Please sign in to comment.