Skip to content

Commit

Permalink
Prettify readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jacobtyq committed Jul 15, 2020
1 parent c0b19a3 commit 835a385
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@
## Getting Started

Export your SVGs that are in your Figma project easily via CLI.

![Gif of exporting process](documentation/export-in-action.gif)

# Pre-requisties
## Pre-requisties

- You will need a DEV_TOKEN (See Step 5 of Setup)
- Your Icons are in a single Frame
Expand All @@ -20,12 +21,12 @@ Your SVGs will be generated in `src/svg` folder

1. `yarn install`
2. Select the frame your icons are in ![Screenshot of a sample Figma project](documentation/export-svg-screenshot.png)
3. Copy the URL in the browser; it should look similar to [https://www.figma.com/file/abcASewbASmnas/Test?node-id=1%3123](https://www.figma.com/file/abcASewbASmnas/Test?node-id=1%3123)
4. Run `node src/setupEnv.js` and paste in your URL copied from step 2 when prompted. This will generate a `.env` file
3. Copy the URL in the browser; it should look similar to `https://www.figma.com/file/abcASewbASmnas/Test?node-id=1%3123`
4. Run `node src/setupEnv.js` and paste in your URL copied from step 3 when prompted. This will generate a `.env` file
5. Generate a DEV_TOKEN a.k.a Personal Access Token by going to Help and Account > Account Settings > Personal Access Token
6. Add your DEV_TOKEN from step 5 into `.env` file
7. Run `node src/index.js` and your SVGs will be generated into `src/svg` folder

### Limitations

Figma API has a fixed number of requests (rate limits) you can call per minute. This script will process a 20 requests per 45 seconds to not hit that limit.
Figma API has a fixed number of requests (rate limits) you can call per minute. This script will process a 20 requests per 45 seconds to avoid hitting that limit.

0 comments on commit 835a385

Please sign in to comment.