diff --git a/README.md b/README.md index 29d7f0d..75d7efc 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,13 @@ > Note: This library is super experimental and alpha. It is the first release of a weekend project. I'll be working to make it better, but the current release is to just let people play around with it. +## Install + +`npm install react-music` + ## Get Started -The easiest way to get started is to clone this repo and run `npm start`. The demo song will be running at [http://localhost:3000](http://localhost:3000). You can open up the `/demo/index.js` file and edit your song there, using the API below as reference. +The easiest way to get started is to clone this repo and run `npm start`. The demo song will be running at [http://localhost:3000](http://localhost:3000). You can open up the `/demo/index.js` file and edit your song there, using the API below as reference. That said, you can import the primitives yourself and run your own build setup, but be aware that hot reloading doesn't work, and runtime prop changes don't propogate yet. @@ -24,7 +28,7 @@ The first thing you want to do is create a `Song` component. This is the control ```js - + ``` @@ -36,7 +40,7 @@ Direct children of `Song` must always be `Sequencer` components. Your `Sequencer ```js - + ```