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

Commit e581a4d

Browse files
committed
npm link
1 parent 161a5ae commit e581a4d

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,13 @@
1010

1111
> 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.
1212
13+
## Install
14+
15+
`npm install react-music`
16+
1317
## Get Started
1418

15-
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.
19+
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.
1620

1721
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.
1822

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

2529
```js
2630
<Song tempo={90}>
27-
31+
2832
</Song>
2933
```
3034

@@ -36,7 +40,7 @@ Direct children of `Song` must always be `Sequencer` components. Your `Sequencer
3640
```js
3741
<Song tempo={90}>
3842
<Sequencer resolution={16} bars={1}>
39-
43+
4044
</Sequencer>
4145
</Song>
4246
```

0 commit comments

Comments
 (0)