Skip to content

Commit

Permalink
Updated the readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
notisrac committed Jun 29, 2024
1 parent 9b2d061 commit 107c8aa
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,23 @@
# Figma to ESPHome display code generator
Generates YML and C++ code for an ESPHome display from a Figma document

## [https://notisrac.github.io/FigmaToESPHome/](https://notisrac.github.io/FigmaToESPHome/)
## Use it here: [https://notisrac.github.io/FigmaToESPHome/](https://notisrac.github.io/FigmaToESPHome/)

## How to use
Fill in the form with the appropriate data and click the ```Generate``` button

### Figma Api URL
URL of the Figma API - you can leave this as is

### Figma Api Token
Your security token for the Figma Api - find more info on how to generate one, [here](https://www.figma.com/developers/api#access-tokens)

### Figma file key
The unique identifier of your Figma file:
![Wher to find the file key](./docs/figma_file_key.png)

### Page name
Name of the page, the design is on. E.g: ```Page 1```

### Frame name
The frame that contains the design. E.g: ```Frame 1``` or ```My awesome design```
Binary file added docs/figma_file_key.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 107c8aa

Please sign in to comment.