README.md, example, and Travis cleanup

Remove the IRC notifications from Travis (we're not using IRC anymore), and the
stable/experimental badge from README.md (because they aren't being kept up to
date).

While there, updated both the README and the example to not use the now-obsolete
`.enableWakeup` method.

Signed-off-by: Gergely Nagy <algernon@keyboard.io>
pull/365/head
Gergely Nagy 6 years ago
parent 637943c924
commit 403754f915

@ -7,13 +7,6 @@ install:
script:
- make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware
notifications:
irc:
channels:
- "chat.freenode.net#keyboardio"
use_notice: true
skip_join: true
template:
- "%{repository_name}/%{branch} %{commit} by %{author}: %{commit_subject} %{build_url} %{message}"
email:
on_success: change
on_failure: change

@ -1,17 +1,12 @@
# Kaleidoscope-HostPowerManagement
![status][st:experimental] [![Build Status][travis:image]][travis:status]
[![Build Status][travis:image]][travis:status]
[travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-HostPowerManagement.svg?branch=master
[travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-HostPowerManagement
[st:stable]: https://img.shields.io/badge/stable-✔-black.svg?style=flat&colorA=44cc11&colorB=494e52
[st:broken]: https://img.shields.io/badge/broken-X-black.svg?style=flat&colorA=e05d44&colorB=494e52
[st:experimental]: https://img.shields.io/badge/experimental----black.svg?style=flat&colorA=dfb317&colorB=494e52
Support performing custom actions whenever the host suspends, resumes, or is
sleeping. Additionally, this plugin provides optional support for the keyboard
to wake the host up from suspend.
sleeping.
## Using the plugin
@ -26,21 +21,12 @@ KALEIDOSCOPE_INIT_PLUGINS(HostPowerManagement);
void setup () {
Kaleidoscope.setup ();
HostPowerManagement.enableWakeup();
}
```
## Plugin methods
The plugin provides the `HostPowerManagement` object, which has the following methods:
### `.enableWakeup()`
> Enables host wakeup support. When enabled, pressing any key on the keyboard
> will wake the host up.
>
> Once enabled, it **cannot** be disabled again.
The plugin provides the `HostPowerManagement` object, with no public methods.
## Overrideable methods

@ -64,8 +64,6 @@ KALEIDOSCOPE_INIT_PLUGINS(LEDControl,
void setup() {
Kaleidoscope.setup();
HostPowerManagement.enableWakeup();
}
void loop() {

Loading…
Cancel
Save