README.md & 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).

Also updated the README.md example to use `KALEIDOSCOPE_INIT_PLUGINS`.

Signed-off-by: Gergely Nagy <algernon@keyboard.io>
pull/389/head
Gergely Nagy 6 years ago
parent e6f7072288
commit 2a0d12b2d9

@ -7,13 +7,6 @@ install:
script: script:
- make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware - make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware
notifications: 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: email:
on_success: change on_success: change
on_failure: change on_failure: change

@ -1,14 +1,10 @@
# Kaleidoscope-HostOS # Kaleidoscope-HostOS
![status][st:stable] [![Build Status][travis:image]][travis:status] [![Build Status][travis:image]][travis:status]
[travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-HostOS.svg?branch=master [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-HostOS.svg?branch=master
[travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-HostOS [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-HostOS
[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
The `HostOS` extension is not all that useful in itself, rather, it is a The `HostOS` extension is not all that useful in itself, rather, it is a
building block other plugins and extensions can use to not repeat the same building block other plugins and extensions can use to not repeat the same
guesswork and logic. Its primary purpose is to help either detect, or keep track guesswork and logic. Its primary purpose is to help either detect, or keep track
@ -50,9 +46,9 @@ void someFunction(void) {
} }
} }
void setup(void) { KALEIDOSCOPE_INIT_PLUGINS(HostOS);
Kaleidoscope.use(&HostOS);
void setup(void) {
Kaleidoscope.setup (); Kaleidoscope.setup ();
} }
``` ```

Loading…
Cancel
Save