Skip to content
This repository was archived by the owner on Jun 14, 2018. It is now read-only.

Commit 876dbb4

Browse files
committed
Update README.md
1 parent 81115bc commit 876dbb4

File tree

1 file changed

+8
-14
lines changed

1 file changed

+8
-14
lines changed

README.md

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# vue-webpack-boilerplate
1+
# vue-webpack-typescript-boilerplate
22

3-
> A full-featured Webpack setup with hot-reload, unit testing & css extraction.
3+
> A full-featured Webpack + typescript setup with hot-reload, unit testing & css extraction.
44
5-
> This template is Vue 2.0 compatible. For Vue 1.x use this command: `vue init webpack#1.0 my-project`
5+
> This template is Vue 2.0 compatible.
66
77
## Documentation
88

@@ -15,7 +15,7 @@ This is a project template for [vue-cli](https://github.com/vuejs/vue-cli). **It
1515

1616
``` bash
1717
$ npm install -g vue-cli
18-
$ vue init webpack my-project
18+
$ vue init ryutamaki/vue-template-webpack-typescript my-project
1919
$ cd my-project
2020
$ npm install
2121
$ npm run dev
@@ -24,7 +24,7 @@ $ npm run dev
2424
## What's Included
2525

2626
- `npm run dev`: first-in-class development experience.
27-
- Webpack + `vue-loader` for single file Vue components.
27+
- Webpack + `vue-loader` + `ts-loader` for single file Vue components.
2828
- State preserving hot-reload
2929
- State preserving compilation error overlay
3030
- Source maps
@@ -36,20 +36,14 @@ $ npm run dev
3636
- All static assets compiled with version hashes for efficient long-term caching, and a production `index.html` is auto-generated with proper URLs to these generated assets.
3737

3838
- `npm run unit`: Unit tests run in PhantomJS with [Karma](http://karma-runner.github.io/0.13/index.html) + [Mocha](http://mochajs.org/) + [karma-webpack](https://github.com/webpack/karma-webpack).
39-
- Supports ES2015 in test files.
39+
- Supports typescript in test files.
4040
- Supports all webpack loaders.
4141
- Easy mock injection.
42+
- Coverage
43+
- TODO: `.vue` file coverage exporting
4244

4345
- `npm run e2e`: End-to-end tests with [Nightwatch](http://nightwatchjs.org/).
4446
- Run tests in multiple browsers in parallel.
4547
- Works with one command out of the box:
4648
- Selenium and chromedriver dependencies automatically handled.
4749
- Automatically spawns the Selenium server.
48-
49-
### Fork It And Make Your Own
50-
51-
You can fork this repo to create your own boilerplate, and use it with `vue-cli`:
52-
53-
``` bash
54-
vue init username/repo my-project
55-
```

0 commit comments

Comments
 (0)