Skip to content

Commit ccbcc15

Browse files
Stub docs
1 parent 8a03cfe commit ccbcc15

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# JavaScript library for micro:bit connections in browsers via USB and Bluetooth
2+
3+
This project is a work in progress. We are extracting WebUSB and Web Bluetooth code from the [micro:bit Python Editor](https://github.com/microbit-foundation/python-editor-v3/) and other projects.
4+
5+
It is intended to be used by other Micro:bit Educational Foundation projects that need to connect to a BBC micro:bit.
6+
7+
The API is not stable and it's not yet recommended that third parties use this project.
8+
9+
## License
10+
11+
This software is under the MIT open source license.
12+
13+
[SPDX-License-Identifier: MIT](LICENSE)
14+
15+
We use dependencies via the NPM registry as specified by the package.json file under common Open Source licenses.
16+
17+
Full details of each package can be found by running `license-checker`:
18+
19+
```bash
20+
$ npx license-checker --direct --summary --production
21+
```
22+
23+
Omit the flags as desired to obtain more detail.
24+
25+
## Code of Conduct
26+
27+
Trust, partnership, simplicity and passion are our core values we live and
28+
breathe in our daily work life and within our projects. Our open-source
29+
projects are no exception. We have an active community which spans the globe
30+
and we welcome and encourage participation and contributions to our projects
31+
by everyone. We work to foster a positive, open, inclusive and supportive
32+
environment and trust that our community respects the micro:bit code of
33+
conduct. Please see our [code of conduct](https://microbit.org/safeguarding/)
34+
which outlines our expectations for all those that participate in our
35+
community and details on how to report any concerns and what would happen
36+
should breaches occur.

0 commit comments

Comments
 (0)