Skip to content

Commit 4b97cee

Browse files
committed
Update README & add automated build check
1 parent 35d58e8 commit 4b97cee

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

.github/workflows/checks.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Checks
2+
3+
on:
4+
push:
5+
paths:
6+
- 'src/**'
7+
- 'tsconfig.json'
8+
- 'package.json'
9+
- 'yarn.lock'
10+
pull_request:
11+
12+
jobs:
13+
build:
14+
name: Build test
15+
runs-on: ubuntu-latest
16+
steps:
17+
- uses: actions/checkout@v3
18+
with:
19+
ref: ${{github.event.pull_request.head.sha}}
20+
- uses: actions/setup-node@v3
21+
with:
22+
node-version: 16
23+
- run: yarn install --frozen-lockfile
24+
- run: yarn build

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
11
# MCH2022 WebUSB API library
2+
![latest NPM release](https://img.shields.io/npm/v/@badge.team/badge-webusb?style=flat-square)
3+
![bundle size](https://img.shields.io/bundlephobia/min/@badge.team/badge-webusb?style=flat-square)
4+
![license](https://img.shields.io/github/license/badgeteam/mch2022-webusb-lib?style=flat-square)
5+
6+
This library allows easy WebUSB communication with the MCH2022 badge, and possibly
7+
more badges in the future.
28

39
## Endpoints
410
```TS
@@ -40,3 +46,13 @@ interface BadgeAPI {
4046
}
4147
```
4248
TODO: auto generated docs :)
49+
50+
## Credits
51+
* Renze Nicolai (@renzenicolai): WebUSB implementation (firmware + JS client)
52+
* Reinier van der Leer (@Pwuts): TypeScript conversion & documentation
53+
54+
## References
55+
* [WebUSB implementation] in the MCH2022 badge firmware
56+
* [MDN WebUSB API spec](https://developer.mozilla.org/en-US/docs/Web/API/WebUSB_API)
57+
58+
[WebUSB implementation]: https://github.com/badgeteam/mch2022-firmware-esp32/blob/master/main/webusb.c

0 commit comments

Comments
 (0)