# \<honorlock-elements>

This webcomponent follows the [open-wc](https://github.com/open-wc/open-wc) recommendation.

## Installation

```bash
npm i --save @honorlock/elements
```

## Build Instructions

```bash
npm run build
```

## Usage

```html
import '@honorlock/elements'

<honorlock-elements></honorlock-elements>
```

## CDN
### Using CDN with the lastest version
```html
<script type="module" src="https://unpkg.com/@honorlock/elements"></script>

<honorlock-elements></honorlock-elements>
```

### Using CDN with a specific version
```html
<script type="module" src="https://unpkg.com/@honorlock/elements/@x.x.x"></script>

<honorlock-elements></honorlock-elements>
```

## Linting and formatting

To scan the project for linting and formatting errors, run

```bash
npm run lint
```

To automatically fix linting and formatting errors, run

```bash
npm run format
```

## Testing with Web Test Runner

To execute a single test run:

```bash
npm run test
```

To run the tests in interactive watch mode run:

```bash
npm run test:watch
```
## Tooling configs

For most of the tools, the configuration is in the `package.json` to reduce the amount of files in your project.

If you customize the configuration a lot, you can consider moving them to individual files.

## Local Demo with `web-dev-server`

```bash
npm start
```

To run a local development server that serves the basic demo located in `demo/index.html`