Skip to content

Commit

Permalink
Merge pull request #11 from matthewp/started
Browse files Browse the repository at this point in the history
Link to the codesandbox
  • Loading branch information
matthewp authored Oct 31, 2018
2 parents a8aa1ed + 8185d0c commit d9f3c0f
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Haunted 🦇 🎃

React's Hook API but for standard web components and [lit-html](https://polymer.github.io/lit-html/).
React's Hooks API but for standard web components and [lit-html](https://polymer.github.io/lit-html/).

```html
<!doctype html>
<html lang="en">

<my-counter></my-counter>


<script type="module">
import { html } from 'https://unpkg.com/lit-html/lit-html.js';
import { component, useState } from 'https://unpkg.com/@matthewp/haunted/haunted.js';
Expand All @@ -25,9 +25,13 @@ React's Hook API but for standard web components and [lit-html](https://polymer.
</script>
```

## Getting started

A starter app is available on [codesandbox](https://codesandbox.io/s/github/matthewp/haunted-starter-app/tree/master/) and also can be clone from [this repo](https://github.com/matthewp/haunted-starter-app). This app gives you the basics of how to use Haunted and build components.

## Use

For now it is available as the `@matthewp/haunted` package. In the future I hope to get the non-scoped name.
Currently __Haunted__ is available as the `@matthewp/haunted` package. In the future I hope to get the non-scoped name.

```shell
npm install @matthewp/haunted
Expand Down

0 comments on commit d9f3c0f

Please sign in to comment.