From 8185d0c1f12808bc8b037957bd7ac45edb923877 Mon Sep 17 00:00:00 2001 From: Matthew Phillips Date: Wed, 31 Oct 2018 17:58:12 -0400 Subject: [PATCH] Link to the codesandbox This adds a section on Getting Started. Maybe in the future I'll add some more stuff here but for now it just links to the codesandbox I created. --- readme.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/readme.md b/readme.md index 6972eb1..b9e4105 100644 --- a/readme.md +++ b/readme.md @@ -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 + - ``` +## 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