Skip to content

Commit 0390bd5

Browse files
jelbournkara
jelbourn
authored and
kara
committed
docs(readme): add project status (#1159)
1 parent 818290b commit 0390bd5

File tree

1 file changed

+92
-14
lines changed

1 file changed

+92
-14
lines changed

‎README.md

Lines changed: 92 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,26 +5,104 @@
55

66
This is the home for the Angular team's Material Design components built on top of Angular 2.
77

8-
### Project status
9-
The alpha has begun! See the [changelog](CHANGELOG.md) for more information.
8+
#### Quick links
9+
[Google group](https://groups.google.com/forum/#!forum/angular-material2),
10+
[Contributing](https://github.com/angular/material2/blob/master/CONTRIBUTING.md),
11+
[Plunker Template](http://plnkr.co/edit/o077B6uEiiIgkC0S06dd?p=preview)
1012

11-
You also might want to check out our [Getting Started Guide](https://github.com/angular/material2/blob/master/GETTING_STARTED.md) if you're
12-
building your first project with Angular Material 2.
13+
### Getting started
1314

15+
See our [Getting Started Guide](https://github.com/angular/material2/blob/master/GETTING_STARTED.md)
16+
if you're building your first project with Angular Material 2.
17+
18+
### Project status
19+
Angular Material 2 is currently in alpha and under active development.
1420
During alpha, breaking API and behavior changes will be occurring regularly.
1521

16-
Check out our [directory of design documents](https://github.com/angular/material2/wiki/Design-doc-directory) for more insight into our process.
22+
Check out our [directory of design documents](https://github.com/angular/material2/wiki/Design-doc-directory)
23+
for more insight into our process.
1724

18-
We are still getting our CI infrastructure (tests, lint etc.) set up, as well as building out
19-
the core library pieces that components will be built upon. If you'd like to contribute,
20-
please look through the issues (which should be up-to-date on who is working on which features and
21-
which pieces are blocked) and make a comment.
22-
Also see our [`Good for community contribution`](https://github.com/angular/material2/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+for+community+contribution%22) label.
25+
If you'd like to contribute, you must follow our [contributing guidelines](https://github.com/angular/material2/blob/master/CONTRIBUTING.md).
26+
You can look through the issues (which should be up-to-date on who is working on which features
27+
and which pieces are blocked) and make a comment.
28+
Also see our [`Good for community contribution`](https://github.com/angular/material2/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+for+community+contribution%22)
29+
label.
2330

24-
#### Quick links
25-
[Google group](https://groups.google.com/forum/#!forum/angular-material2),
26-
[Contributing](https://github.com/angular/material2/blob/master/CONTRIBUTING.md),
27-
[Plunker Template](http://plnkr.co/edit/o077B6uEiiIgkC0S06dd?p=preview)
31+
High level items planned for September 2016:
32+
* Work on Angular core towards 2.0.0 final
33+
* Preparing for conferences (Angular Connect and ng-europe)
34+
* Final features for dialog
35+
* Initial version of snackbar.
36+
* Additional behaviors for menu, start design for select.
37+
* Finalize high-level design details for data-table.
38+
39+
40+
#### Feature status:
41+
42+
| Feature | Status | Docs | Issue |
43+
|------------------|-------------------------------------|--------------|--------|
44+
| button | Available | [README][1] | - |
45+
| cards | Available | [README][2] | - |
46+
| checkbox | Available | [README][3] | - |
47+
| radio | Available | [README][4] | - |
48+
| input | Available | [README][5] | - |
49+
| sidenav | Available | [README][6] | - |
50+
| toolbar | Available | [README][7] | - |
51+
| list | Available | [README][8] | #107 |
52+
| grid-list | Available | [README][9] | - |
53+
| icon | Available | [README][10] | - |
54+
| progress-circle | Available | [README][11] | - |
55+
| progress-bar | Available | [README][12] | - |
56+
| tabs | Available | [README][13] | - |
57+
| slide-toggle | Available | [README][14] | - |
58+
| button-toggle | Available | [README][15] | - |
59+
| slider | Available | [README][16] | - |
60+
| menu | Initial version, needs enhancements | [README][17] | #119 |
61+
| tooltip | Initial version, needs enhancements | [README][18] | - |
62+
| ripples | Available, but needs to be applied | [README][19] | #108 |
63+
| dialog | Started, not yet ready for release | - | #114 |
64+
| snackbar / toast | Proof-of-concept | - | #115 |
65+
| select | Not started | - | #118 |
66+
| textarea | Not started | - | #546 |
67+
| autocomplete | Not started | - | #117 |
68+
| chips | Not started | - | #120 |
69+
| theming | Designed, no code yet | - | #123 |
70+
| prod build | Not started | - | - |
71+
| docs site | UX design and tooling in progress | - | - |
72+
| typography | Not started | - | #205 |
73+
| layout | Not started | - | - |
74+
| fab speed-dial | Not started | - | #860 |
75+
| fab toolbar | Not started | - | - |
76+
| bottom-sheet | Not started | - | - |
77+
| bottom-nav | Not started | - | #408 |
78+
| virtual-repeat | Not started | - | #823 |
79+
| datepicker | Not started | - | #675 |
80+
| data-table | Not started | - | #581 |
81+
| stepper | Not started | - | #508 |
82+
83+
[1]: https://github.com/angular/material2/blob/master/src/lib/button/README.md
84+
[2]: https://github.com/angular/material2/blob/master/src/lib/card/README.md
85+
[3]: https://github.com/angular/material2/blob/master/src/lib/checkbox/README.md
86+
[4]: https://github.com/angular/material2/blob/master/src/lib/radio/README.md
87+
[5]: https://github.com/angular/material2/blob/master/src/lib/input/README.md
88+
[6]: https://github.com/angular/material2/blob/master/src/lib/sidenav/README.md
89+
[7]: https://github.com/angular/material2/blob/master/src/lib/toolbar/README.md
90+
[8]: https://github.com/angular/material2/blob/master/src/lib/list/README.md
91+
[9]: https://github.com/angular/material2/blob/master/src/lib/grid-list/README.md
92+
[10]: https://github.com/angular/material2/blob/master/src/lib/icon/README.md
93+
[11]: https://github.com/angular/material2/blob/master/src/lib/progress-circle/README.md
94+
[12]: https://github.com/angular/material2/blob/master/src/lib/progress-bar/README.md
95+
[13]: https://github.com/angular/material2/blob/master/src/lib/tabs/README.md
96+
[14]: https://github.com/angular/material2/blob/master/src/lib/slide-toggle/README.md
97+
[15]: https://github.com/angular/material2/blob/master/src/lib/button-toggle/README.md
98+
[16]: https://github.com/angular/material2/blob/master/src/lib/slider/README.md
99+
[17]: https://github.com/angular/material2/blob/master/src/lib/menu/README.md
100+
[18]: https://github.com/angular/material2/blob/master/src/lib/tooltip/README.md
101+
[19]: https://github.com/angular/material2/blob/master/src/lib/core/ripple/README.md
102+
103+
104+
"Available" means that the components or feature is published and available for use, but may still
105+
be missing some behaviors or polish.
28106

29107
## The goal of Angular Material
30108
Our goal is to build a set of high-quality UI components built with Angular 2 and TypeScript,

0 commit comments

Comments
 (0)