Skip to content

Commit

Permalink
📝 docs: update README file
Browse files Browse the repository at this point in the history
  • Loading branch information
omidnikrah committed Oct 7, 2024
1 parent 0bd9433 commit dace7ea
Showing 1 changed file with 24 additions and 4 deletions.
28 changes: 24 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,30 @@
<img src="/assets/sprite-logo.svg" width="120" alt="Sprite Logo" />
</p>

<h3 align="center">🎨 Figma Sprite Generator</h2>

<p align="center">Easily generate sprite sheets and JSON metadata from icons selected in Figma.</p>

### Install the plugin
<p align="center">
<a href="https://github.com/omidnikrah/figma-sprite-generator/releases/download/v1.0.1/figma-sprite-generator-1.0.1.zip">
<img src="https://img.shields.io/badge/Download%20Figma%20Plugin-F24E1E?logo=figma&logoColor=white" alt="Figma Plugin" height="25" />
</a>
</p>

<h2></h2>

### ⚡ Quick Installation Guide:

1. In the Figma desktop app, open a Figma document.
2. Search for and run `Import plugin from manifest…` via the Quick Actions search bar.
3. Select the `manifest.json` file that was generated by the `build` script.
1. **[Download the plugin .zip file](https://github.com/your-username/your-repo/releases/latest/download/your-plugin-name.zip)** to your computer.
2. Unzip the file to reveal the plugin folder.
3. In Figma, head to `Plugins` > `Development` > `Import plugin from manifest...`.
4. Choose the `manifest.json` file from the unzipped folder.
5. 🎉 That’s it! You’re all set to start designing smarter.

<h2></h2>

<br />

<p align="center">
<a href="https://www.buymeacoffee.com/omidnikrah" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee"></a>
</p>

0 comments on commit dace7ea

Please sign in to comment.