Skip to content

Commit a69970c

Browse files
committed
update readme
1 parent 0384b12 commit a69970c

File tree

1 file changed

+14
-18
lines changed

1 file changed

+14
-18
lines changed

README.md

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,27 @@
1-
# angular2-webpack
1+
# angular-webpack
22

3-
[![Dependency Status](https://david-dm.org/preboot/angular2-webpack/status.svg)](https://david-dm.org/preboot/angular2-webpack#info=dependencies) [![devDependency Status](https://david-dm.org/preboot/angular2-webpack/dev-status.svg)](https://david-dm.org/preboot/angular2-webpack#info=devDependencies)
4-
[![Join the chat at https://gitter.im/preboot/angular2-webpack](https://badges.gitter.im/preboot/angular2-webpack.svg)](https://gitter.im/preboot/angular2-webpack?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
3+
[![Dependency Status](https://david-dm.org/preboot/angular-webpack/status.svg)](https://david-dm.org/preboot/angular-webpack#info=dependencies) [![devDependency Status](https://david-dm.org/preboot/angular-webpack/dev-status.svg)](https://david-dm.org/preboot/angular-webpack#info=devDependencies)
4+
[![Join the chat at https://gitter.im/preboot/angular-webpack](https://badges.gitter.im/preboot/angular-webpack.svg)](https://gitter.im/preboot/angular-webpack?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
55

6-
A complete, yet simple, starter for Angular 2 using Webpack.
6+
A complete, yet simple, starter for Angular v2+ using Webpack.
77

8-
This seed repo serves as an Angular 2 starter for anyone looking to get up and running with Angular 2 and TypeScript fast. Using [Webpack](http://webpack.github.io/) for building our files and assisting with boilerplate. We're also using Protractor for our end-to-end story and Karma for our unit tests.
9-
* Best practices in file and application organization for [Angular 2](https://angular.io/).
8+
This seed repo serves as an Angular starter for anyone looking to get up and running with Angular and TypeScript fast. Using [Webpack](http://webpack.github.io/) for building our files and assisting with boilerplate. We're also using Protractor for our end-to-end story and Karma for our unit tests.
9+
* Best practices in file and application organization for [Angular](https://angular.io/).
1010
* Ready to go build system using [Webpack](https://webpack.github.io/docs/) for working with [TypeScript](http://www.typescriptlang.org/).
11-
* Testing Angular 2 code with [Jasmine](http://jasmine.github.io/) and [Karma](http://karma-runner.github.io/).
11+
* Testing Angular code with [Jasmine](http://jasmine.github.io/) and [Karma](http://karma-runner.github.io/).
1212
* Coverage with [Istanbul](https://github.com/gotwarlost/istanbul)
13-
* End-to-end Angular 2 code using [Protractor](https://angular.github.io/protractor/).
13+
* End-to-end Angular code using [Protractor](https://angular.github.io/protractor/).
1414
* Stylesheets with [SASS](http://sass-lang.com/) (not required, it supports regular css too).
1515
* Error reported with [TSLint](http://palantir.github.io/tslint/) and [Codelyzer](https://github.com/mgechev/codelyzer).
1616
* Documentation with [TypeDoc](http://typedoc.org/).
1717

1818
>Warning: Make sure you're using the latest version of Node.js and NPM
1919
20-
[Is Angular 2 Ready Yet?](http://splintercode.github.io/is-angular-2-ready/)
21-
2220
### Quick start
2321

24-
> Clone/Download the repo then edit `app.ts` inside [`/src/app/app.component.ts`](/src/app/app.component.ts)
25-
2622
```bash
2723
# clone our repo
28-
$ git clone https://github.com/preboot/angular2-webpack.git my-app
24+
$ git clone https://github.com/preboot/angular-webpack.git my-app
2925

3026
# change directory to your app
3127
$ cd my-app
@@ -57,7 +53,7 @@ go to [http://localhost:8080](http://localhost:8080) in your browser.
5753

5854
What you need to run this app:
5955
* `node` and `npm` (Use [NVM](https://github.com/creationix/nvm))
60-
* Ensure you're running Node (`v5.x.x`+) and NPM (`3.x.x`+)
56+
* Ensure you're running Node (`v6.x.x`+) and NPM (`3.x.x`+)
6157

6258
## Installing
6359

@@ -117,19 +113,19 @@ You can generate api docs (using [TypeDoc](http://typedoc.org/)) for your code w
117113

118114
No, Webpack will add all the needed Javascript bundles as script tags and all the CSS files as link tags. The advantage is that you don't need to modify the index.html every time you build your solution to update the hashes.
119115

120-
#### How to include external angular 2 libraries ?
116+
#### How to include external angular libraries ?
121117

122-
It's simple, just install the lib via npm and import it in your code when you need it. Don't forget that you need to configure some external libs in the [bootstrap](https://github.com/preboot/angular2-webpack/blob/master/src/main.ts) of your application.
118+
It's simple, just install the lib via npm and import it in your code when you need it. Don't forget that you need to configure some external libs in the [bootstrap](https://github.com/preboot/angular-webpack/blob/master/src/main.ts) of your application.
123119

124120
#### How to include external css files such as bootstrap.css ?
125121

126-
Just install the lib and import the css files in [vendor.ts](https://github.com/preboot/angular2-webpack/blob/master/src/vendor.ts). For example this is how to do it with bootstrap:
122+
Just install the lib and import the css files in [vendor.ts](https://github.com/preboot/angular-webpack/blob/master/src/vendor.ts). For example this is how to do it with bootstrap:
127123

128124
```sh
129125
npm install bootstrap@next --save
130126
```
131127

132-
And in [vendor.ts](https://github.com/preboot/angular2-webpack/blob/master/src/vendor.ts) add the following:
128+
And in [vendor.ts](https://github.com/preboot/angular-webpack/blob/master/src/vendor.ts) add the following:
133129

134130
```ts
135131
import 'bootstrap/dist/css/bootstrap.css';

0 commit comments

Comments
 (0)