runkit-midi

MIDI player/viewer for RunKit

Your own live MIDI demo on RunKit

Have you ever wondered what that RunKit button on your NPM page was for?

Does your project generate MIDI files?

You may want to enable a live MIDI demo on your project page.

No install required!

Your visitors will be able to play and view the contents of generated MIDI files as on the image below:

Enabling live MIDI demo on your project page

Create a demo script:

// my-demo.js
const rkmidi = require('runkit-midi');
const myproj = require('your-project');
const midi = myproj.makeCoolMidi();
rkmidi(midi);

Add an entry into your package.json:

// package.json
  ...
  "runkitExampleFilename": "my-demo.js",
  ...

Add a button to your README.md (optional):

// README.md
  ...
[![Try your-project on RunKit](https://badge.runkitcdn.com/your-project.svg)](https://npm.runkit.com/your-project)
  ...

Publish the new release of your-project on NPM

Have fun!