Skip to content

Commit ebfc4c0

Browse files
committed
Update README.md
1 parent cd1ea0c commit ebfc4c0

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

README.md

+18-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,24 @@ Hardware instructions coming sometime in the future.
2626

2727
## Usage
2828

29-
TODO Coming soon
29+
### Basic Example
30+
31+
```js
32+
const { LED } = require("pi-led-control");
33+
// Other imports: LEDArray, Animation, Curves
34+
35+
const led = new LED(3);
36+
led.write(true);
37+
led.off();
38+
```
39+
40+
### More Examples
41+
42+
More examples of how to use all of the available imports are available in the [`/examples`](./examples) folder.
43+
44+
### Specifications
45+
46+
TODO. For now, please refer to the examples and JSDocs within the code.
3047

3148
## Development
3249

0 commit comments

Comments
 (0)