CONTRIBUTING.md

May 25, 2015 ยท View on GitHub

Contributing

There are two ways to submit your elements to this list. Both require you to have a GitHub repository, so make sure you write a good repository name and description for better discoverability.

Using Bower

  1. Make sure your bower.json file contains an array of keywords which includes web-components.

    {
    "name": "sample",
    "version": "0.0.0",
    "description": "Lorem ipsum dolor sit amet",
    "keywords": [
        "web-components"
    ]
}

  2. Register your package using CLI.

$ bower register ```

  1. Wait for it to show up! Shouldn't take longer than an hour.

Using npm

  1. Make sure your package.json file contains an array of keywords which includes web-components.

    {
    "name": "sample",
    "version": "0.0.0",
    "description": "Lorem ipsum dolor sit amet",
    "keywords": [
        "web-components"
    ]
}

  2. Register your package using CLI.

$ npm publish ```

  1. Wait for it to show up! Shouldn't take longer than an hour.

Manual Submission

Fork this project and include your repository info in the data/repos.json file.