# my-repo

> My awesome Custom Element

Latest version **0.1.0** (published 2016-04-27) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install my-repo
pnpm add my-repo
yarn add my-repo
bun add my-repo
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2016-04-27 |
| First published | 2016-04-27 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Koan Kyuka |
| Maintainers | actarus16 |

## Links

- npm: https://www.npmjs.com/package/my-repo
- Repository: https://github.com/componentCreatorAccount/my-repo
- Homepage: https://github.com/componentCreatorAccount/my-repo#readme
- Issues: https://github.com/componentCreatorAccount/my-repo/issues
- npm.io page: https://npm.io/package/my-repo

## Recent versions

- 0.1.0 (latest) — 2016-04-27

## README

# <my-repo>

> My awesome Custom Element

## Demo

[Check it live!](http://componentCreatorAccount.github.io/my-repo)

## Install

Install the component using [Bower](http://bower.io/):

```sh
$ bower install my-repo --save
```

Or [download as ZIP](https://github.com/componentCreatorAccount/my-repo/archive/master.zip).

## Usage

1. Import Web Components' polyfill:

    ```html
    <script src="bower_components/webcomponentsjs/webcomponents.min.js"></script>
    ```

2. Import Custom Element:

    ```html
    <link rel="import" href="bower_components/my-repo/dist/my-element.html">
    ```

3. Start using it!

    ```html
    <my-element></my-element>
    ```

## Options

Attribute     | Options     | Default      | Description
---           | ---         | ---          | ---
`foo`         | *string*    | `bar`        | Lorem ipsum dolor.

## Methods

Method        | Parameters   | Returns     | Description
---           | ---          | ---         | ---
`unicorn()`   | None.        | Nothing.    | Magic stuff appears.

## Events

Event         | Description
---           | ---
`onsomething` | Triggers when something happens.

## Development

In order to run it locally you'll need to fetch some dependencies and a basic server setup.

* Install [Bower](http://bower.io/) & [Grunt](http://gruntjs.com/):

    ```sh
    $ [sudo] npm install -g bower grunt-cli
    ```

* Install local dependencies:

    ```sh
    $ bower install && npm install
    ```
    
* To test your project

    ```sh
    $ grunt test
    ```
    
* To view your project, start the development server and open `http://localhost:8000`.

    ```sh
    $ grunt server
    ```

* To build the distribution files before releasing a new version.

    ```sh
    $ grunt build
    ```

* To provide a live demo, send everything to `gh-pages` branch.

    ```sh
    $ grunt deploy
    ```

## Contributing

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -m 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D

## History

For detailed changelog, check [Releases](https://github.com/componentCreatorAccount/my-repo/releases).

## License

[MIT License](http://opensource.org/licenses/MIT)

---
_Source: https://npm.io/package/my-repo · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._