Skip to content

🎵 Create a MIDI file from your Github contributions.

License

Notifications You must be signed in to change notification settings

GMartigny/gh.midi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

gh.midi

NPM version

Download a midi file of your github contributions.

Installation

Using NPM:

$ npm install gh.midi

Using the webservice API:

https://ghmidi.now.sh/api/[USERNAME]

Using the website interface

https://ghmidi.now.sh/

CLI

A CLI version is also available for this package.

Usage

Once installed using NPM, you can require it on your node scripts:

const GHMidi = require("gh.midi");
const midiBytes = GHMidi("[USERNAME]", options);

Options

Days

Number of days from today to include. [default 365]

Chords

Set of 4 chords to use in ascending order. [default: ["C", "F", "G", "Am"]]

BPM

Set the song beat per minutes. [default: 120]

License

MIT