Skip to content

Commit

Permalink
remove outdated note about epoll from readme, add note about installi…
Browse files Browse the repository at this point in the history
…ng on non-linux systems
  • Loading branch information
fivdi committed Mar 6, 2019
1 parent 2bbae3e commit 0832c93
Showing 1 changed file with 3 additions and 6 deletions.
9 changes: 3 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,9 @@ can now return Promises in scenarios where undefined was previously returned.
npm install onoff
```

Note that although it's possible to install onoff on non-Linux systems the
functionality offered by onoff is only available on Linux systems.

## Usage

#### LEDs and Buttons
Expand Down Expand Up @@ -456,12 +459,6 @@ The GPIO sysfs interface can also be used for interrupt detection. onoff can
detect several thousand interrupts per second on both the BeagleBone and the
Raspberry Pi.

Note that the [epoll package](https://github.com/fivdi/epoll) is currently
only supported on Linux. Attempting to use onoff on non-Linux systems will
result in runtime errors similar to:

`Error: Module did not self-register.`


## Configuring Pullup and Pulldown Resistors

Expand Down

0 comments on commit 0832c93

Please sign in to comment.