Skip to content

Commit 6bebe78

Browse files
committed
Update README for current developer workflow.
1 parent 62dae1c commit 6bebe78

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

+16-6
Original file line numberDiff line numberDiff line change
@@ -30,35 +30,45 @@ yarn add alignment.js
3030

3131
## Development
3232

33-
Install a local copy:
33+
### Installation
3434

3535
```
3636
git clone https://github.com/veg/alignment.js
3737
cd alignment.js
3838
yarn
3939
```
4040

41+
### Application
42+
4143
Start the development server:
4244

4345
```
44-
yarn start
46+
yarn develop
4547
```
4648

47-
Visit `localhost:8000` in a browser (will read from environment variable `$PORT`).
49+
`webpack-dev-server` will find an available port and open up your default browser. Refreshes will automatically occur on writes to files.
50+
51+
### Library
52+
53+
For testing the library in dependent packages before releases, `alignment.js` uses yalc. The library is built by Babeling `src` into `lib`, and `lib` is published. For convenience, this is encapsulated in the following NPM script:
4854

49-
Note that this starts `webpack` in watch mode; refresh to observe changes.
55+
```
56+
yarn yalc
57+
```
5058

5159
## Deployment
5260

5361
### Application
5462

63+
Server will read from environment variable `$PORT`.
64+
5565
```
56-
yarn build-app
66+
yarn app
5767
yarn serve
5868
```
5969

6070
### Library
6171

6272
```
63-
yarn build-lib
73+
yarn library
6474
```

0 commit comments

Comments
 (0)