Skip to content

Commit 9db9d5f

Browse files
docs: Minor update to the Quick Start.
1 parent 285f7f8 commit 9db9d5f

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,14 @@ versions of the micro:bit.
1616
The documentation can be found in
1717
https://microbit-foundation.github.io/microbit-universal-hex/.
1818

19+
## npm Package
20+
21+
To add this package to your project:
22+
23+
```
24+
npm install @microbit/microbit-universal-hex
25+
```
26+
1927
## Web Tool
2028

2129
<img width="18%" alt="microbit-universal-hex logo" src="docs/img/web-tool-screenshot.png" align="left">

docs/quick-guide.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,13 @@ nav_order: 2
88

99
## ES5 UMD Bundle
1010

11-
Create a Universal Hex from two Intel Hex strings:
11+
Download the UMD bundle from a GitHub release and add it to the page:
12+
13+
```html
14+
<script src="microbit-uh.umd.min.js"></script>
15+
```
16+
17+
Then to create a Universal Hex from two Intel Hex strings:
1218

1319
```js
1420
var universalHex = microbitUh.createUniversalHex([
@@ -34,3 +40,10 @@ separatedBinaries.forEach(function (hexObj) {
3440
console.log(hexObj.hex);
3541
});
3642
```
43+
44+
## npm package
45+
46+
You can integrate this library in your project using the npm package:
47+
https://www.npmjs.com/package/@microbit/microbit-universal-hex
48+
49+
For information on how to use this library check the API documentation.

0 commit comments

Comments
 (0)