# README Template Copy the snippet and replace the following * Component name related * `COMPONENT_TITLE`: title case of the component, e.g. Layout Grid * `COMPONENT_ID`: lower dash case name of the component, e.g. layout-grid * `COMPONENT_NAME`: capitalized name of the component, e.g. Layout grid * `MODULE_NAME`: name of the Node module, e.g. layout-grid * `JS_COMPONENT_NAME`: name of the JS component class, e.g. MDCLayoutGrid * [Spec](https://material.io/guidelines) related * `ONE_SENTENCE_FROM_SPEC`: explaining what the component is * `LINK_TO_SPEC`, link to spec: the same article you copied the one sentence from * `NAME_OF_ARTICLE`: name of the article in spec * [Catalog site](https://material.io/components/web/catalog/) related * `SHORT_EXCERPT`: short excerpt about the component * `ICON_ID`: id for the icon representing the component * `SCREENSHOT_NAME`: name of the screenshot image of the component * `SCREENSHOT_WIDTH`: width of the screenshot image of the component * `LINK_TO_CATALOG_SERVER`: link to the component page on [Catalog](https://material-components.github.io/material-components-web-catalog/) * Usage sections * `BASIC_USAGE_SECTION`: see [README standards on Basic Usage](readme_standards.md#basic-usage) * `VARIANTS_SECTION`: see [README standards on Variants](readme_standards.md#variants) * `STYLE_CUSTOMIZATION_SECTION`: see [README standards on Style Customization](readme_standards.md#style-customization) * `MDC_COMPONENT_SECTION`: see [README standards on `MDCComponent` Properties and Methods](readme_standards.md#mdccomponent-properties-and-methods) * `FRAMEWORKS_SECTION`: see [README standards on Usage within Web Frameworks](readme_standards.md#usage-within-web-frameworks) ~~~ # ## Design & API Documentation ## Installation ``` npm install @material/ ``` ## Basic Usage ## Variants ## Style Customization ## `` Properties and Methods ## Usage within Web Frameworks If you are using a JavaScript framework, such as React or Angular, you can create a for your framework. Depending on your needs, you can use the _Simple Approach: Wrapping MDC Web Vanilla Components_, or the _Advanced Approach: Using Foundations and Adapters_. Please follow the instructions [here](../../docs/integrating-into-frameworks.md). ~~~