Skip to content

Commit 3d92f51

Browse files
hanslhansl
committed
release: rewrite the README slightly and reorder packages
1 parent 44086c6 commit 3d92f51

File tree

4 files changed

+51
-9
lines changed

4 files changed

+51
-9
lines changed

‎.monorepo.json‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@
5151
},
5252
"@angular/cli": {
5353
"name": "Angular CLI",
54+
"section": "Tooling",
5455
"links": [
5556
{
5657
"label": "README",
@@ -158,6 +159,7 @@
158159
},
159160
"@angular-devkit/schematics-cli": {
160161
"name": "Schematics CLI",
162+
"section": "Tooling",
161163
"version": "0.7.0-beta.1",
162164
"hash": "9af2b27b3c56da136d5ce9f9cfec0208",
163165
"snapshotRepo": "angular/angular-devkit-schematics-cli-builds"

‎README.md‎

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@
1313
# Angular DevKit
1414
### Development tools and libraries specialized for Angular
1515

16+
This is the home of the DevKit and the Angular CLI code. You can find the Angular CLI specific README
17+
[here](https://github.com/angular/angular-cli/blob/master/packages/angular/cli/README.md).
18+
1619

1720
[![CircleCI branch](https://img.shields.io/circleci/project/github/angular/angular-cli/master.svg?label=circleci)](https://circleci.com/gh/angular/angular-cli) [![Dependency Status](https://david-dm.org/angular/angular-cli.svg)](https://david-dm.org/angular/angular-cli) [![devDependency Status](https://david-dm.org/angular/angular-cli/dev-status.svg)](https://david-dm.org/angular/angular-cli?type=dev)
1821

@@ -41,16 +44,24 @@ as it is today will become one of many interfaces available to perform those tas
4144
will also be available to third party tools and IDEs.
4245

4346

44-
## Packages
45-
This is a monorepo which contains many packages:
4647

4748

49+
## Tools
50+
51+
| Project | Package | Version | Links |
52+
|---|---|---|---|
53+
**Angular CLI** | [`@angular/cli`](https://npmjs.com/package/@angular/cli) | [![latest](https://img.shields.io/npm/v/%40angular%2Fcli/latest.svg)](https://npmjs.com/package/@angular/cli) | [![README](https://img.shields.io/badge/README--green.svg)](https://github.com/angular/angular-cli/blob/master/packages/angular/cli/README.md) [![snapshot](https://img.shields.io/badge/snapshot--blue.svg)](https://github.com/angular/cli-builds)
54+
**Schematics CLI** | [`@angular-devkit/schematics-cli`](https://npmjs.com/package/@angular-devkit/schematics-cli) | [![latest](https://img.shields.io/npm/v/%40angular-devkit%2Fschematics-cli/latest.svg)](https://npmjs.com/package/@angular-devkit/schematics-cli) | [![snapshot](https://img.shields.io/badge/snapshot--blue.svg)](https://github.com/angular/angular-devkit-schematics-cli-builds)
55+
56+
57+
58+
## Packages
59+
This is a monorepo which contains many packages:
4860

4961

5062

5163
| Project | Package | Version | Links |
5264
|---|---|---|---|
53-
**Angular CLI** | [`@angular/cli`](https://npmjs.com/package/@angular/cli) | [![latest](https://img.shields.io/npm/v/%40angular%2Fcli/latest.svg)](https://npmjs.com/package/@angular/cli) | [![README](https://img.shields.io/badge/README--green.svg)](https://github.com/angular/angular-cli/blob/master/packages/angular/cli/README.md) [![snapshot](https://img.shields.io/badge/snapshot--blue.svg)](https://github.com/angular/cli-builds)
5465
**Architect** | [`@angular-devkit/architect`](https://npmjs.com/package/@angular-devkit/architect) | [![latest](https://img.shields.io/npm/v/%40angular-devkit%2Farchitect/latest.svg)](https://npmjs.com/package/@angular-devkit/architect) | [![README](https://img.shields.io/badge/README--green.svg)](https://github.com/angular/angular-cli/blob/master/packages/angular_devkit/architect/README.md) [![snapshot](https://img.shields.io/badge/snapshot--blue.svg)](https://github.com/angular/angular-devkit-architect-builds)
5566
**Architect CLI** | [`@angular-devkit/architect-cli`](https://npmjs.com/package/@angular-devkit/architect-cli) | [![latest](https://img.shields.io/npm/v/%40angular-devkit%2Farchitect-cli/latest.svg)](https://npmjs.com/package/@angular-devkit/architect-cli) | [![snapshot](https://img.shields.io/badge/snapshot--blue.svg)](https://github.com/angular/angular-devkit-architect-cli-builds)
5667
**Build Angular** | [`@angular-devkit/build-angular`](https://npmjs.com/package/@angular-devkit/build-angular) | [![latest](https://img.shields.io/npm/v/%40angular-devkit%2Fbuild-angular/latest.svg)](https://npmjs.com/package/@angular-devkit/build-angular) | [![README](https://img.shields.io/badge/README--green.svg)](https://github.com/angular/angular-cli/blob/master/packages/angular_devkit/build_angular/README.md) [![snapshot](https://img.shields.io/badge/snapshot--blue.svg)](https://github.com/angular/angular-devkit-build-angular-builds)
@@ -59,7 +70,6 @@ This is a monorepo which contains many packages:
5970
**Build Webpack** | [`@angular-devkit/build-webpack`](https://npmjs.com/package/@angular-devkit/build-webpack) | [![latest](https://img.shields.io/npm/v/%40angular-devkit%2Fbuild-webpack/latest.svg)](https://npmjs.com/package/@angular-devkit/build-webpack) | [![README](https://img.shields.io/badge/README--green.svg)](https://github.com/angular/angular-cli/blob/master/packages/angular_devkit/build_webpack/README.md) [![snapshot](https://img.shields.io/badge/snapshot--blue.svg)](https://github.com/angular/angular-devkit-build-webpack-builds)
6071
**Core** | [`@angular-devkit/core`](https://npmjs.com/package/@angular-devkit/core) | [![latest](https://img.shields.io/npm/v/%40angular-devkit%2Fcore/latest.svg)](https://npmjs.com/package/@angular-devkit/core) | [![README](https://img.shields.io/badge/README--green.svg)](https://github.com/angular/angular-cli/blob/master/packages/angular_devkit/core/README.md) [![snapshot](https://img.shields.io/badge/snapshot--blue.svg)](https://github.com/angular/angular-devkit-core-builds)
6172
**Schematics** | [`@angular-devkit/schematics`](https://npmjs.com/package/@angular-devkit/schematics) | [![latest](https://img.shields.io/npm/v/%40angular-devkit%2Fschematics/latest.svg)](https://npmjs.com/package/@angular-devkit/schematics) | [![README](https://img.shields.io/badge/README--green.svg)](https://github.com/angular/angular-cli/blob/master/packages/angular_devkit/schematics/README.md) [![snapshot](https://img.shields.io/badge/snapshot--blue.svg)](https://github.com/angular/angular-devkit-schematics-builds)
62-
**Schematics CLI** | [`@angular-devkit/schematics-cli`](https://npmjs.com/package/@angular-devkit/schematics-cli) | [![latest](https://img.shields.io/npm/v/%40angular-devkit%2Fschematics-cli/latest.svg)](https://npmjs.com/package/@angular-devkit/schematics-cli) | [![snapshot](https://img.shields.io/badge/snapshot--blue.svg)](https://github.com/angular/angular-devkit-schematics-cli-builds)
6373

6474
#### Schematics
6575

‎packages/angular/cli/README.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
## Angular CLI
22

33
<!-- Badges section here. -->
4-
[![Build Status](https://img.shields.io/travis/angular/angular-cli/master.svg?label=travis)][travis-badge-url]
54
[![Dependency Status][david-badge]][david-badge-url]
65
[![devDependency Status][david-dev-badge]][david-dev-badge-url]
76

‎scripts/templates/readme.ejs‎

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@
1313
# Angular DevKit
1414
### Development tools and libraries specialized for Angular
1515

16+
This is the home of the DevKit and the Angular CLI code. You can find the Angular CLI specific README
17+
[here](https://github.com/angular/angular-cli/blob/master/packages/angular/cli/README.md).
18+
1619
<%# Badges are created here. %>
1720
<% for (const section of monorepo.badges) {
1821
for (const { label, image, title, url } of section) {
@@ -49,16 +52,44 @@ as it is today will become one of many interfaces available to perform those tas
4952
will also be available to third party tools and IDEs.
5053

5154

52-
## Packages
53-
This is a monorepo which contains many packages:
54-
5555
<%
5656
const sections = [
5757
...new Set(Object.keys(packages).map(pkgName => monorepo.packages[pkgName].section ))
58-
].filter(x => x);
58+
].filter(x => x && x != 'Tooling');
5959
sections.unshift(undefined);
6060
%>
6161

62+
## Tools
63+
64+
| Project | Package | Version | Links |
65+
|---|---|---|---|
66+
<%
67+
for (const pkgName of Object.keys(packages)) {
68+
const pkg = packages[pkgName];
69+
const mrPkg = monorepo.packages[pkgName];
70+
71+
if (pkg.private) {
72+
continue;
73+
}
74+
if (mrPkg.section != 'Tooling') {
75+
continue;
76+
}
77+
78+
%>**<%= mrPkg.name%>**<%
79+
%> | [`<%= pkgName %>`](https://npmjs.com/package/<%= pkgName %>)<%
80+
%> | [![latest](https://img.shields.io/npm/v/<%= encode(pkgName) %>/latest.svg)](https://npmjs.com/package/<%= pkgName %>)<%
81+
%> | <% for (const link of mrPkg.links || []) {
82+
%>[![<%= link.label %>](https://img.shields.io/badge/<%= link.label %>--<%= link.color || 'green' %>.svg)](<%= link.url %>)<%
83+
}
84+
if (mrPkg.snapshotRepo) {
85+
%> [![snapshot](https://img.shields.io/badge/snapshot--blue.svg)](https://github.com/<%= mrPkg.snapshotRepo %>)<%
86+
} %>
87+
<% } %>
88+
89+
90+
## Packages
91+
This is a monorepo which contains many packages:
92+
6293
<% for (const section of sections) {
6394
6495
%><%= section ? '#### ' + section : '' %>

0 commit comments

Comments
 (0)