Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lyimmi authored Dec 28, 2023
1 parent 506aabd commit 00d7335
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,16 @@
[![Example](https://github.com/lyimmi/usbrelay/actions/workflows/go-example.yml/badge.svg)](https://github.com/lyimmi/usbrelay/actions/workflows/go-example.yml)
[![UmockdevTest](https://github.com/lyimmi/usbrelay/actions/workflows/test.yml/badge.svg)](https://github.com/lyimmi/usbrelay/actions/workflows/test.yml)

<img align="right" src="https://github.com/lyimmi/usbrelay/assets/8627125/d26081dd-3dd9-47fc-841f-3d89fbe11b68" width="160" height="160" alt="usb hid relay">

A package for controlling USB relay boards with HID API in go, capable of controlling any number of channels on a relay board.

**This package is work in progress, the public interface and behavior may change.**

The package uses [karalabe/hid](https://github.com/karalabe/hid) to access and control the USB device.
karalabe/hid has a simple interface, embeds `libusb` that makes this package `go get`-able.


## Usage

### Requirements
Expand Down

0 comments on commit 00d7335

Please sign in to comment.