Skip to content
This repository was archived by the owner on Jan 13, 2025. It is now read-only.

Commit 97c6494

Browse files
Omer Zivtraviskaufman
authored andcommitted
docs: Update README (#83)
Suggested changes to the main Readme for the repo
1 parent d249859 commit 97c6494

File tree

1 file changed

+13
-25
lines changed

1 file changed

+13
-25
lines changed

README.md

Lines changed: 13 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,23 @@
1-
# Material Components Web (MDC-Web)
1+
# Material Components for the web
22

3-
> Project status: **pre-alpha**
3+
Material Components for the web (MDC-Web) help developers execute [Material Design](https://www.material.io).
4+
Developed by a core team of engineers and UX designers at Google, these components enable a reliable development workflow to build beautiful and functional web projects.
45

5-
## Overview
6-
7-
MDC-Web is the next generation of Material Design components for the Web, incorporating the latest in material design thinking and a flexible component architecture under the hood. It is the successor to [Material Design Lite](https://getmdl.io/).
8-
9-
The project has 3 high-level goals:
6+
Material Components for the web is the successor to [Material Design Lite](https://getmdl.io/), and has 3 high-level goals:
107

118
- Production-ready components consumable in an a-la-carte fashion
12-
- Best-in-class performance and adherence to the [material design guidelines](https://material.google.com)
9+
- Best-in-class performance and adherence to the [Material Design guidelines](https://material.google.com)
1310
- Seamless integration with other JS frameworks and libraries
1411

15-
In order to achieve these goals, we are planning a complete re-architecture of the original MDL component library, alongside new tooling and infrastructure.
16-
17-
Please see our [developer's guide](docs/developer.md) for more in-depth information.
12+
## Useful Links
1813

14+
- [Developer's Guide](docs/developer.md)
15+
- [All Components](packages/)
16+
- [Demos](demos/)
17+
- [Framework Integration Examples](framework-examples/)
18+
- [Contributing](CONTRIBUTING.md)
19+
- [Material.io](https://www.material.io) (external site)
20+
- [Material Design Guidelines](https://material.google.com) (external site)
1921

2022
## Getting Started
2123

@@ -41,17 +43,3 @@ open http://localhost:8080
4143
- Firefox
4244
- IE 11/Edge
4345
- Opera
44-
45-
46-
## Contributing
47-
48-
We welcome early feedback from the community, though we recommend waiting until an alpha release before opening any pull requests.
49-
50-
See also our [contributing guidelines](CONTRIBUTING.md).
51-
52-
53-
## License
54-
55-
© Google, 2016. Licensed under an
56-
[Apache-2](LICENSE)
57-
license.

0 commit comments

Comments
 (0)