Skip to content
This repository has been archived by the owner on Feb 18, 2022. It is now read-only.

Commit

Permalink
npm link
Browse files Browse the repository at this point in the history
  • Loading branch information
kenwheeler committed Aug 22, 2016
1 parent 161a5ae commit e581a4d
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -24,7 +28,7 @@ The first thing you want to do is create a `Song` component. This is the control

```js
<Song tempo={90}>

</Song>
```

Expand All @@ -36,7 +40,7 @@ Direct children of `Song` must always be `Sequencer` components. Your `Sequencer
```js
<Song tempo={90}>
<Sequencer resolution={16} bars={1}>

</Sequencer>
</Song>
```
Expand Down

0 comments on commit e581a4d

Please sign in to comment.