Skip to content

Commit 1ba470d

Browse files
committed
docs(README): clarify installation instructions, resolve #107
1 parent 8452b14 commit 1ba470d

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,26 @@
22

33
## Development
44

5+
### Quick start
6+
57
```
6-
$ yarn start
8+
$ yarn install // installs all dependencies
9+
$ yarn start // starts local server
710
```
811

9-
or
12+
When started successfully, you may access the local server at http://localhost:8000/
13+
14+
### Troubleshooting
15+
16+
Some issues can be resolved by clearing the cache and rebuilding files. The first command is less destructive, while the second resets your local environment from scratch.
1017

1118
```
1219
$ yarn clear // clears local cache, builds (excludes node_modules)
20+
```
21+
22+
or
23+
24+
```
1325
$ yarn clean // clears local cache, builds, node_modules, yarn trash
1426
```
1527

0 commit comments

Comments
 (0)