Skip to content

Commit a602f64

Browse files
authored
Update README.md
1 parent 61ba07d commit a602f64

File tree

1 file changed

+1
-36
lines changed

1 file changed

+1
-36
lines changed

README.md

Lines changed: 1 addition & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1 @@
1-
Below are the steps to get your widget running. You can also find instructions at:
2-
3-
https://www.figma.com/widget-docs/setup-guide/
4-
5-
This widget template uses Typescript and NPM, two standard tools in creating JavaScript applications.
6-
7-
First, download Node.js which comes with NPM. This will allow you to install TypeScript and other
8-
libraries. You can find the download link here:
9-
10-
https://nodejs.org/en/download/
11-
12-
Next, install TypeScript and the latest type definitions by running:
13-
14-
npm install
15-
16-
If you are familiar with JavaScript, TypeScript will look very familiar. In fact, valid JavaScript code
17-
is already valid Typescript code.
18-
19-
TypeScript adds type annotations to variables. This allows code editors such as Visual Studio Code
20-
to provide information about the Figma API while you are writing code, as well as help catch bugs
21-
you previously didn't notice.
22-
23-
For more information, visit https://www.typescriptlang.org/
24-
25-
Using TypeScript requires a compiler to convert TypeScript (code.tsx) into JavaScript (code.js)
26-
for the browser to run.
27-
28-
We recommend writing TypeScript code using Visual Studio code:
29-
30-
1. Download Visual Studio Code if you haven't already: https://code.visualstudio.com/.
31-
2. Open this directory in Visual Studio Code.
32-
3. Compile TypeScript to JavaScript: Run the "Terminal > Run Build Task..." menu item,
33-
then select "npm: watch". You will have to do this again every time
34-
you reopen Visual Studio Code.
35-
36-
That's it! Visual Studio Code will regenerate the JavaScript file every time you save.
1+
<img width="629" alt="CleanShot 2022-09-23 at 05 17 26@2x" src="https://user-images.githubusercontent.com/1888355/191842838-c08512bd-aa75-4b65-af95-2232d70ada9d.png">

0 commit comments

Comments
 (0)