Skip to content

Commit cd8fc17

Browse files
committed
Configure webpack-dev-server, update docs with development commands
1 parent f1f5ad9 commit cd8fc17

File tree

4 files changed

+26
-5
lines changed

4 files changed

+26
-5
lines changed

README.hbs

+10-1
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,20 @@ Using npm:
1919
$ npm i circletype --save
2020
```
2121

22-
Load ES6 module:
22+
Load ES module:
2323
```js
2424
import CircleType from `circletype`;
2525
```
2626

2727
# API
2828

2929
{{>main}}
30+
31+
## Development Commands
32+
33+
| Command | Description |
34+
|:-------------------|:------------------------------|
35+
| `npm run dev` | Start dev server |
36+
| `npm start` | Build for release |
37+
| `npm test` | Run unit and screenshot tests |
38+
| `npm run docs` | Generate documentation |

README.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Using npm:
1919
$ npm i circletype --save
2020
```
2121

22-
Load ES6 module:
22+
Load ES module:
2323
```js
2424
import CircleType from `circletype`;
2525
```
@@ -159,3 +159,12 @@ const circleType = new CircleType(document.getElementById('myElement'));
159159
// Restore `myElement` to its original state.
160160
circleType.destroy();
161161
```
162+
163+
## Development Commands
164+
165+
| Command | Description |
166+
|:-------------------|:------------------------------|
167+
| `npm run dev` | Start dev server |
168+
| `npm start` | Build for release |
169+
| `npm test` | Run unit and screenshot tests |
170+
| `npm run docs` | Generate documentation |

dist/circletype.min.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
{
22
"name": "circletype",
3-
"version": "2.0.11",
3+
"version": "2.1.0",
44
"description": "A JavaScript library that lets you curve type on the web.",
55
"main": "dist/circletype.min.js",
66
"files": [
77
"dist"
88
],
99
"repository": "peterhry/CircleType",
1010
"scripts": {
11+
"dev": "webpack-dev-server --open",
12+
"start": "eslint src && npm t && npm run docs && webpack -p",
1113
"test": "jest src --notify && docker run -w /usr/data -v \"$PWD\":/usr/data tenjaa/java-chrome-nodejs npm run backstop",
1214
"backstop": "backstop test",
1315
"docs": "jsdoc2md --template README.hbs --files src/class.js > README.md"
@@ -35,6 +37,7 @@
3537
"eslint-plugin-import": "2.7.0",
3638
"jest": "21.0.2",
3739
"jsdoc-to-markdown": "3.0.0",
38-
"webpack": "3.5.6"
40+
"webpack": "3.5.6",
41+
"webpack-dev-server": "2.9.4"
3942
}
4043
}

0 commit comments

Comments
 (0)