open-wc/packages/generator-open-wc/generators/vanilla-bare/templates/README.md

<<%= props.tagName %>>

This webcomponent follows the open-wc recommendation.

Installation

npm i <%= props.tagName %>

Usage

<script type="module">
  import '<%= props.tagName %>/<%= props.tagName %>.js';
</script>

<<%= props.tagName %>></<%= props.tagName %>>

Demos using storybook (if applied by author)

npm run storybook
# visit provided url

Linting using eslint (if applied by author)

npm run lint:eslint