Skip to content
This repository was archived by the owner on Feb 17, 2024. It is now read-only.

Commit 8b1a293

Browse files
committed
🌟 Readme and package.json update.
1 parent 293f773 commit 8b1a293

File tree

2 files changed

+32
-26
lines changed

2 files changed

+32
-26
lines changed

README.md

+20-23
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,28 @@
1-
# Angular Lib starter
2-
> Universal, AOT, Web Workers, ready lib starter. Use for your Angular libs
1+
<p align="center">
2+
<a href="http://courses.angularclass.com/courses/angular-2-fundamentals" target="_blank">
3+
<img width="438" alt="Angular 2 Fundamentals" src="https://cloud.githubusercontent.com/assets/1016365/17200649/085798c6-543c-11e6-8ad0-2484f0641624.png">
4+
</a>
5+
</p>
36

7+
---
48

5-
## Getting started
6-
* fork this
7-
* clear the git history `git init .`
8-
* add your source code in `src`.
9-
* change the entry in `webpack.config.js`
10-
* change the output filnames in `package.json` to match your src files and webpack
11-
* `"main", "jsnext:main", "module", "types"`
12-
* build your project `yarn release` or `npm run release`
9+
# Angular Web Cached View
10+
> Allow rendering of Angular apps in cached views
1311
14-
## Builds
15-
This starter prepares 2 different versions for builds of your lib
16-
* **esm** or ES2015 Modules
17-
* this build is a transpilation of your Typescript code to ES5 and ES2015 modules. Its' not bundled. This is needed for treeshaking when users use your lib
18-
* **UMD**
19-
* this is a bundle of ES5 code. What you would typically get from webpack or rollup.
12+
___
2013

21-
The build system generates AOT metadata too, so you're good.
14+
enjoy — **AngularClass**
2215

2316

2417
## Scripts
2518
* `"test"`: runs the test in mocha on node
26-
* `"build:esm"`: builds the esm versions
27-
* `"build:bundle"`: builds the UMD version
28-
* `"build:aot"`: makes it work for aot
29-
* `"build"`: does all the above
30-
* `"copy"`: copies over file to dist
31-
* `"release"`: does all the above
19+
* `"rm"`: removes dist folder
20+
* `"build"`: runs rm, then runs webpack
21+
22+
23+
<br><br>
24+
25+
[![AngularClass](https://cloud.githubusercontent.com/assets/1016365/9863770/cb0620fc-5af7-11e5-89df-d4b0b2cdfc43.png "Angular Class")](https://angularclass.com)
26+
## [AngularClass](https://angularclass.com)
27+
> Learn AngularJS, Angular 2, and Modern Web Development from the best.
28+
> Looking for corporate Angular training, want to host us, or Angular consulting? [email protected]

package.json

+12-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,21 @@
11
{
2-
"name": "angular-lib-starter",
2+
"name": "@angularclass/web-cached-view",
33
"version": "0.0.1",
4-
"description": "Starter to make Angular libs",
4+
"description": "",
55
"main": "bundle.js",
66
"jsnext:main": "angular-web-cached-view.module.js",
77
"module": "angular-web-cached-view.module.js",
88
"types": "index.d.ts",
9+
"repository": {
10+
"type": "git",
11+
"url": "git+https://github.com/AngularClass/angular-web-cached-view.git"
12+
},
13+
"author": "AngularClass",
14+
"license": "Apache-2.0",
15+
"bugs": {
16+
"url": "https://github.com/AngularClass/angular-web-cached-view/issues"
17+
},
18+
"homepage": "https://github.com/AngularClass/angular-web-cached-view#readme",
919
"scripts": {
1020
"test": "rimraf ./tmp/mocha-webpack && mocha-webpack --opts 'mocha.opts'",
1121
"build:esm": "ntsc -p tsconfig.esm.json",
@@ -15,7 +25,6 @@
1525
"copy": "cp package.json dist && cp README.md dist",
1626
"release": "npm run build && npm run copy"
1727
},
18-
"license": "MIT",
1928
"devDependencies": {
2029
"@angular/common": "^4.1.3",
2130
"@angular/compiler": "^4.1.3",

0 commit comments

Comments
 (0)