-
Notifications
You must be signed in to change notification settings - Fork 2.1k
docs: update main readme with React and Web Components links #2727
Conversation
README.md
Outdated
@@ -18,6 +18,8 @@ Material Components for the web is the successor to [Material Design Lite](https | |||
- [Blox Material](https://blox.src.zone/material): Angular Integration Library. | |||
- [Vue MDC Adapter](https://github.com/stasson/vue-mdc-adapter): MDC Web Integration for Vue.js (using [foundation/adapters](./docs/integrating-into-frameworks.md#the-advanced-approach-using-foundations-and-adapters).) | |||
- [Material Components Vue](https://github.com/matsp/material-components-vue): MDC Web Integration for Vue.js (using [vanilla components](./docs/integrating-into-frameworks.md#the-simple-approach-wrapping-mdc-web-vanilla-components)) | |||
- [Material Components React](https://github.com/material-components/material-components-web-react): MDC Web Integration for React.js (using [foundation/adapters](./docs/integrating-into-frameworks.md#the-advanced-approach-using-foundations-and-adapters)) | |||
- [Material Web Components](https://github.com/material-components/material-components-web-components): MDC Web Integration for Web Components (using [vanilla components](./docs/integrating-into-frameworks.md#the-simple-approach-wrapping-mdc-web-vanilla-components)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What's the value in the self-referential link?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
are you referring to the Material Web Components link? That is the polymer repo
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
MY BAD!!!!! I completely missed that. The name is so similar.
Codecov Report
@@ Coverage Diff @@
## master #2727 +/- ##
=======================================
Coverage 98.48% 98.48%
=======================================
Files 98 98
Lines 4230 4230
Branches 537 537
=======================================
Hits 4166 4166
Misses 64 64 Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔥
README.md
Outdated
@@ -18,6 +18,8 @@ Material Components for the web is the successor to [Material Design Lite](https | |||
- [Blox Material](https://blox.src.zone/material): Angular Integration Library. | |||
- [Vue MDC Adapter](https://github.com/stasson/vue-mdc-adapter): MDC Web Integration for Vue.js (using [foundation/adapters](./docs/integrating-into-frameworks.md#the-advanced-approach-using-foundations-and-adapters).) | |||
- [Material Components Vue](https://github.com/matsp/material-components-vue): MDC Web Integration for Vue.js (using [vanilla components](./docs/integrating-into-frameworks.md#the-simple-approach-wrapping-mdc-web-vanilla-components)) | |||
- [Material Components React](https://github.com/material-components/material-components-web-react): MDC Web Integration for React.js (using [foundation/adapters](./docs/integrating-into-frameworks.md#the-advanced-approach-using-foundations-and-adapters)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we consider putting these at the top given that they're first-party whereas the others are third-party? Maybe even have a separate sub-bullet for third-party integrations?
e.g.
- Seamless integration with other JS frameworks and libraries
- Material Components for React (note the presence of "for", too)
- Material Web Components
- Additional third-party integrations
- (rest of list here)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Found a few more nits
README.md
Outdated
- [Blox Material](https://blox.src.zone/material): Angular Integration Library. | ||
- [Vue MDC Adapter](https://github.com/stasson/vue-mdc-adapter): MDC Web Integration for Vue.js (using [foundation/adapters](./docs/integrating-into-frameworks.md#the-advanced-approach-using-foundations-and-adapters).) | ||
- [Material Components Vue](https://github.com/matsp/material-components-vue): MDC Web Integration for Vue.js (using [vanilla components](./docs/integrating-into-frameworks.md#the-simple-approach-wrapping-mdc-web-vanilla-components)) | ||
- [Material Components for React](https://github.com/material-components/material-components-web-react): MDC Web Integration for React.js (using [foundation/adapters](./docs/integrating-into-frameworks.md#the-advanced-approach-using-foundations-and-adapters)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Drop ".js" from React? (It's referred to simply as React on their own site)
- lowercase i in integration
- foundation -> foundations
README.md
Outdated
- [Vue MDC Adapter](https://github.com/stasson/vue-mdc-adapter): MDC Web Integration for Vue.js (using [foundation/adapters](./docs/integrating-into-frameworks.md#the-advanced-approach-using-foundations-and-adapters).) | ||
- [Material Components Vue](https://github.com/matsp/material-components-vue): MDC Web Integration for Vue.js (using [vanilla components](./docs/integrating-into-frameworks.md#the-simple-approach-wrapping-mdc-web-vanilla-components)) | ||
- [Material Components for React](https://github.com/material-components/material-components-web-react): MDC Web Integration for React.js (using [foundation/adapters](./docs/integrating-into-frameworks.md#the-advanced-approach-using-foundations-and-adapters)) | ||
- [Material Web Components](https://github.com/material-components/material-components-web-components): MDC Web Integration for Web Components (using [vanilla components](./docs/integrating-into-frameworks.md#the-simple-approach-wrapping-mdc-web-vanilla-components)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lowercase i in integration
fixes material-components/material-components-web-react#26