Skip to content

Commit ea9a555

Browse files
Docs: Add very basic example in WIP Quick Guide.
1 parent 3262e2b commit ea9a555

File tree

2 files changed

+30
-1
lines changed

2 files changed

+30
-1
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ lib-fesm
1414
fesm
1515
umd
1616
bundles
17-
docs
1817
dist
1918

2019
## this is generated by `npm pack`

docs/quick-guide.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
layout: default
3+
title: Quick Guide
4+
nav_order: 2
5+
---
6+
7+
# Quick Guide
8+
9+
## ES5 UMD Bundle
10+
11+
```js
12+
var universalHex = microbitUh.createUniversalHex([
13+
{
14+
hex: intelHexString1,
15+
boardId: 0x1,
16+
},
17+
{
18+
hex: intelHexString2,
19+
boardId: 0x2,
20+
},
21+
]);
22+
23+
if (microbitUh.isUniversalHex(intelHexStr)) {
24+
var separatedBinaries = microbitUh.separateUniversalHex(intelHexStr);
25+
}
26+
separatedBinaries.forEach(function (hexObj) {
27+
console.log(hexObj.boardId);
28+
console.log(hexObj.hex);
29+
});
30+
```

0 commit comments

Comments
 (0)