Tools for Deno-Powered Web Extensions
chore: update publish to include readme
+7
-21
+5
-2
.github/workflows/deno.yml
+5
-2
.github/workflows/deno.yml
+1
-18
README.md
+1
-18
README.md
···
4
4
5
5
# Usage
6
6
7
-
You can see [bext_preact_template](https://github.com/bpevs/bext_preact_template) as an example of basic usage and how to setup a working environment.
7
+
You can see basic examples here: https://github.com/bpevs/bext/examples
8
8
9
9
You can also see a real-world example by looking at [Favioli](https://github.com/bpevs/favioli).
10
10
···
88
88
getStorageStub.restore()
89
89
})
90
90
```
91
-
92
-
# Running this repo (for Bext development)
93
-
94
-
Tasks are defined in [deno.json](./deno.json), but basically:
95
-
96
-
- `deno task dev:{project}`: Run the example app in watch-mode
97
-
- `deno task test`: Makes sure it all works. Use this before committing!
98
-
- runs fmt, lint, type-checks, unit tests for source and example apps
99
-
- builds example apps using local bext copy
100
-
101
-
## `/examples`
102
-
103
-
Note that the `deno tasks` in the example projects are meant to show the client usage, and therefore have tasks that don't work within the context of this repo's workspace.
104
-
105
-
If you want to run these projects from the Bext repo, please use the tasks in the root `deno.json` (instead of the `deno.json` in the `/examples/{project}`)
106
-
107
-
Also, for this same reason, do not put any imports in the root `deno.json`.