Skip to content

Commit e48971f

Browse files
Update README.md
1 parent 07f738d commit e48971f

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -168,21 +168,23 @@ You can find the documentation here:
168168

169169
## Contribute
170170

171-
To get a reloadable env, with map, clone this project and
171+
Local development is broken into two parts (ideally using two tabs).
172172

173-
```shell
174-
npm install
175-
npm run start
176-
# open browser at localhost:4000
177-
```
173+
First, run rollup to watch your `src/` module and automatically recompile it into `dist/` whenever you make changes.
178174

179-
## Thank you
175+
```bash
176+
npm start # runs rollup with watch flag
177+
```
180178

181-
(*Really big thanks to [April Arcus](https://github.com/AprilArcus) for documentation fixes*)
179+
The second part will be running the `example/` create-react-app that's linked to the local version of your module.
182180

183-
(*thank you [Dan Abramov](http://gaearon.github.io/react-dnd/) for titles structure*)
181+
```bash
182+
# (in another tab)
183+
cd example
184+
npm start # runs create-react-app dev server
185+
```
184186

185-
(*great thanks to [Vladimir Akimov](https://github.com/b2whats) he knows why*)
187+
Now, anytime you make a change to your library in `src/` or to the example app's `example/src`, `create-react-app` will live-reload your local dev server so you can iterate on your component in real-time.
186188

187189
## License
188190

0 commit comments

Comments
 (0)