Skip to content

Commit 48c447b

Browse files
committed
fix: typos in README
1 parent f45cf05 commit 48c447b

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
<!-- Slogan -->
88
<p align="center">
9-
A figma plugin boilerplate, that makes it easy building plugins with React + Vite!
9+
Create scalable Figma plugins with ease, using the power of React + Vite!
1010
</p>
1111

1212
<!-- Badges -->
@@ -32,15 +32,15 @@
3232

3333
## Key Features
3434

35-
1. **_Logical Sides in Mind:_** Figma plugins that render a UI works on two different processes (split into code.js and index.html in Figma docs). This boilerplate keeps sides separated, by allowing them to share code (under `./src/common/`).
35+
1. **_Logical Sides in Mind:_** Figma plugins that render a UI work on two different processes (split into code.js and index.html in Figma docs). This boilerplate keeps the sides separated by allowing them to share code (under ./src/common/).
3636

3737
2. **_Intercommunitive:_** Logical sides should be able to communicate with each other without creating huge and unscalable nested if statements. This boilerplate solves it by declaring isolated messages (under `./src/common/network/messages/`)!
3838

39-
3. **_Easy to Build:_** Configure the vite config with your plugin credentials once, then just build with your everyday `npm run build` command! The `/dist` folder will be ready to publish already!
39+
3. **_Easy to Build:_** Configure the `figma.manifest.ts` config with your plugin credentials once, then just build with your everyday `npm run build` command! The `/dist` folder will be ready to publish already!
4040

41-
4. **_Bundled into One File:_** Figma plugins only accept single file for main (js) and ui (html), which makes deployment of multiple files linked to each other impossible. This boilerplate is configured to bundle/inline most of the things you need like: rasterize/vector image asset imports, css url statements and of course source code imports.
41+
4. **_Bundled into One File:_** Figma plugins only accept a single file for `main` (js) and `ui` (html), which makes deployment of multiple files linked to each other impossible. This boilerplate is configured to bundle/inline most of the things you need like rasterize/vector image asset imports, CSS URL statements, and of course, source code imports.
4242

43-
5. **_SVG as Component:_** Yes, you can import SVG's as inlined sources with `*.svg?inline`, but what about actually importing them as React components? Easy! You can import an svg file as React component with `*.svg?component`! (See `/src/ui/app.tsx` for examples)
43+
5. **_SVG as Component:_** Yes, you can import SVGs as inlined sources with `*.svg?inline`, but what about actually importing them as React components? Easy! You can import an SVG file as a React component with `*.svg?component!` (See `/src/ui/app.tsx` for examples)
4444

4545
6. **_Sassy:_** A classic, this boilerplate supports Sass/Scss/Less and modules! Check out `/src/ui/styles/` for 7-1 Sass Template and `/src/ui/components/Button.module.scss` for module examples.
4646

@@ -67,7 +67,7 @@ npm run dev
6767

6868
### Building
6969

70-
Building by the following command line will yield with a `dist` folder, which is ready to be used by Figma:
70+
Building with the following command line will yield with a `dist` folder, which is ready to be used by Figma:
7171

7272
```
7373
npm run build
@@ -94,7 +94,7 @@ After building, built `dist` folder is going to contain every artifact you need
9494

9595
### 1. Make sure to either inline or component SVG imports!
9696

97-
Importing image assets other than `.svg` is easy. However, when you are importing you MUST make sure it is imported using either one of the suffices `?inline` or `?component`.
97+
Importing image assets other than `.svg` is easy. However, when you are importing `.svg` you MUST make sure it is imported using either one of the suffixes `?inline` or `?component`.
9898

9999
```tsx
100100
// ❌ WRONG! Won't be visible in Figma

0 commit comments

Comments
 (0)