Skip to content

Commit b9e7bf6

Browse files
committed
docs: 📝 Update README. Added demo section.
1 parent 4d544c3 commit b9e7bf6

File tree

2 files changed

+13
-9
lines changed

2 files changed

+13
-9
lines changed

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Svelte Typescript Chrome Extension Boilerplate
22

3-
> Boilerplate for Chrome Extension Svelte Typescript project
3+
Boilerplate for Chrome Extension Svelte Typescript project.
44

55
## Features
66

@@ -10,6 +10,10 @@
1010
- [CRXJS Vite Plugin](https://github.com/crxjs/chrome-extension-tools/blob/main/packages/vite-plugin/README.md)
1111
- [Chrome Extensions Manifest V3](https://developer.chrome.com/docs/extensions/mv3/intro/)
1212

13+
## Demo
14+
15+
![Demo](/demo.gif)
16+
1317
## Examples of integrations
1418

1519
- [Tailwind CSS](https://tailwindcss.com/) – is in the [tailwindcss](https://github.com/NekitCorp/chrome-extension-svelte-typescript-boilerplate/tree/tailwindcss) branch
@@ -25,17 +29,17 @@ npm i
2529
npm run dev
2630
```
2731

28-
## Build
29-
30-
```bash
31-
# build files to `/dist` directory
32-
$ npm run build
33-
```
34-
35-
## Load unpacked extensions
32+
### Load unpacked extensions
3633

3734
[Getting Started Tutorial](https://developer.chrome.com/docs/extensions/get-started/tutorial/hello-world#load-unpacked)
3835

3936
1. Open the Extension Management page by navigating to `chrome://extensions`.
4037
2. Enable Developer Mode by clicking the toggle switch next to `Developer mode`.
4138
3. Click the `LOAD UNPACKED` button and select the `/dist` directory.
39+
40+
## Build
41+
42+
```bash
43+
# build files to `/dist` directory
44+
$ npm run build
45+
```

demo.gif

1.07 MB
Loading

0 commit comments

Comments
 (0)