Skip to content

Commit

Permalink
docs(README): Link to API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
motiz88 committed May 31, 2016
1 parent ee6d3fc commit 7f9a334
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,16 @@
[![js-semistandard-style][semistandard-image]][semistandard-url]
[![MIT License][license-image]][license-url]

[API documentation][doc-url] (up-to-date with `master`)

This module provides a store enhancer and a set of action creators wrapping the Web MIDI API for use in Redux apps.

* The list of MIDI devices is kept up-to-date in the state tree for your own reducers to use; updates are sent via the `RECEIVE_DEVICE_LIST` action.
* Dispatch a `SEND_MIDI_MESSAGE` action with a device ID, MIDI data and optional timestamp, and it will be sent.
* Dispatch a `SET_LISTENING_DEVICES` action with the IDs of one or more input devices and you will begin receiving messages from them.
* Listen for `RECEIVE_MIDI_MESSAGE` actions to handle incoming MIDI messages.

This repo is a work in progress. Watch this space for updates and in the mean time have a look at the source code for a better idea of what's going on.
This repo is a work in progress. Watch this space for updates and in the mean time have a look at the [documentation][doc-url] and the source code for a better idea of what's going on.

[travis-image]: https://img.shields.io/travis/motiz88/redux-midi.svg?style=flat-square
[travis-url]: https://travis-ci.org/motiz88/redux-midi
Expand All @@ -28,3 +30,4 @@ This repo is a work in progress. Watch this space for updates and in the mean ti
[semistandard-url]: https://github.com/Flet/semistandard
[coverage-image]: https://img.shields.io/coveralls/motiz88/redux-midi.svg?style=flat-square
[coverage-url]: https://coveralls.io/github/motiz88/redux-midi?branch=master
[doc-url]: http://motiz88.github.io/redux-midi/

0 comments on commit 7f9a334

Please sign in to comment.