Skip to content

Commit

Permalink
feat(npm-keywords): finalize keyword taxonomy, add to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
amsheehan committed Feb 7, 2017
1 parent f916a02 commit 6ce693b
Show file tree
Hide file tree
Showing 14 changed files with 43 additions and 35 deletions.
11 changes: 11 additions & 0 deletions docs/authoring-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -496,6 +496,17 @@ Additionally, all new components require the following within their `package.jso

This is needed so that lerna will be able to automatically publish new scoped packages.

```
"keywords": {
"material components",
"material design",
<COMPONENT_NAME>
}
```

For example, if we are building a checkbox component, `keywords` would include `material components`, `material design`, and `checkbox`


### License Stanzas

We are required to put the following at the _top_ of _every source code file_, including tests,
Expand Down
3 changes: 1 addition & 2 deletions packages/mdc-icon-toggle/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@
"keywords": [
"material components",
"material design",
"icon",
"toggle"
"icon toggle"
],
"main": "index.js",
"repository": {
Expand Down
6 changes: 6 additions & 0 deletions packages/mdc-layout-grid/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@
"version": "0.1.0",
"description": "The Material Components for the web layout grid component",
"license": "Apache-2.0",
"keywords": [
"material components",
"material design",
"grid",
"layout"
],
"repository": {
"type": "git",
"url": "https://github.com/material-components/material-components-web.git"
Expand Down
5 changes: 2 additions & 3 deletions packages/mdc-list/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@
"license": "Apache-2.0",
"keywords": [
"material components",
"material",
"list",
"scss"
"material design",
"list"
],
"repository": {
"type": "git",
Expand Down
5 changes: 2 additions & 3 deletions packages/mdc-menu/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@
"license": "Apache-2.0",
"keywords": [
"material components",
"material",
"menu",
"scss"
"material design",
"menu"
],
"main": "index.js",
"repository": {
Expand Down
6 changes: 2 additions & 4 deletions packages/mdc-radio/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,8 @@
"license": "Apache-2.0",
"keywords": [
"material components",
"material",
"radio",
"javascript",
"scss"
"material design",
"radio"
],
"main": "index.js",
"repository": {
Expand Down
6 changes: 2 additions & 4 deletions packages/mdc-ripple/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,8 @@
"license": "Apache-2.0",
"keywords": [
"material components",
"material",
"ripple",
"javascript",
"scss"
"material design",
"ripple"
],
"main": "index.js",
"repository": {
Expand Down
5 changes: 2 additions & 3 deletions packages/mdc-rtl/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,9 @@
"license": "Apache-2.0",
"keywords": [
"material components",
"material",
"material design",
"rtl",
"right to left",
"scss"
"right to left"
],
"repository": {
"type": "git",
Expand Down
5 changes: 2 additions & 3 deletions packages/mdc-select/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,9 @@
"license": "Apache-2.0",
"keywords": [
"material components",
"material",
"material design",
"select",
"multi select",
"scss"
"multi select"
],
"main": "index.js",
"repository": {
Expand Down
5 changes: 2 additions & 3 deletions packages/mdc-snackbar/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@
"license": "Apache-2.0",
"keywords": [
"material components",
"material",
"snackbar",
"scss"
"material design",
"snackbar"
],
"main": "index.js",
"repository": {
Expand Down
5 changes: 5 additions & 0 deletions packages/mdc-switch/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
"description": "The Material Components for the web switch component",
"version": "0.1.0",
"license": "Apache-2.0",
"keywords": [
"material components",
"material design",
"switch"
],
"repository": {
"type": "git",
"url": "https://github.com/material-components/material-components-web.git"
Expand Down
6 changes: 2 additions & 4 deletions packages/mdc-textfield/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,8 @@
"license": "Apache-2.0",
"keywords": [
"material components",
"material",
"textfield",
"javascript",
"scss"
"material design",
"textfield"
],
"main": "index.js",
"repository": {
Expand Down
5 changes: 2 additions & 3 deletions packages/mdc-theme/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@
"license": "Apache-2.0",
"keywords": [
"material components",
"material",
"theme",
"scss"
"material design",
"theme"
],
"repository": {
"type": "git",
Expand Down
5 changes: 2 additions & 3 deletions packages/mdc-typography/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,9 @@
"license": "Apache-2.0",
"keywords": [
"material components",
"material",
"material design",
"typography",
"font",
"scss"
"font"
],
"repository": {
"type": "git",
Expand Down

0 comments on commit 6ce693b

Please sign in to comment.