An open API service indexing awesome lists of open source software.

https://github.com/webcomponents/hello-world-xtag

Web Component example using X-Tag
https://github.com/webcomponents/hello-world-xtag

Last synced: 5 months ago
JSON representation

Web Component example using X-Tag

Awesome Lists containing this project

README

          

# <hello-world>

> A Web Component example using [X-Tag](http://x-tags.org/).
>
> Looking for a boilerplate? Check [x-tag-boilerplate](https://github.com/webcomponents/x-tag-boilerplate).

## Demo

[Check it live!](http://webcomponents.github.io/hello-world-xtag)

## Install

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

```sh
$ bower install hello-world-xtag --save
```

Or [download as ZIP](https://github.com/webcomponents/hello-world-xtag/archive/master.zip).

## Usage

1. Import polyfill:

```html

```

2. Import custom element:

```html

```

3. Start using it!

```html

```

## Options

Attribute | Options | Default | Description
--- | --- | --- | ---
`who` | *string* | `World` | Who do you want to say hello?

## Development

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

1. Install [bower](http://bower.io/) & [polyserve](https://npmjs.com/polyserve):

```sh
$ npm install -g bower polyserve
```

2. Install local dependencies:

```sh
$ bower install
```

3. Start development server and open `http://localhost:8080/components/hello-world-xtag/`.

```sh
$ polyserve
```

## History

For detailed changelog, check [Releases](https://github.com/webcomponents/hello-world-xtag/releases).

## License

[MIT License](http://webcomponentsorg.mit-license.org/) © WebComponents.org