# <%= componentName %>
The <%= componentName %> React UI component.

> Created with the [Faithlife HTML Component Tools project generator](https://git/logos/html-component-tools)

## Installation
Make sure your project is set up to use the [Faithlife npm registry](http://npm.faithlife.io) with an `.npmrc` file.

```shell
yarn add @faithlife/<%= componentName %>
```

## Use
See the [example app in this repo](./examples/basic/app.jsx) for example usage.

## Building
Review the [Cross-platform HTML Component Development Guidelines](https://git/Logos/html-component-guidelines).

To build the project:
1. [Install yarn](https://yarnpkg.com/en/docs/install), if necessary
1. Clone this repo
1. `yarn`
1. `yarn start` will start a dev server
1. `yarn build` before you commit to run the linter and test suite