From 252071727d4318c6c8e30a1b34056c2e9993ecc9 Mon Sep 17 00:00:00 2001 From: Ian Richardson Date: Sat, 2 Mar 2019 14:33:43 -0600 Subject: [PATCH] Update README.md --- README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 49 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7441df7a..7ca7fae9 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,49 @@ -# boilerplate-card -A community driven boilerplate for best practices +# Boilerplate Card +A community driven boilerplate of best practices from Home Assistant Lovelace custom cards + +[![GitHub Release][releases-shield]][releases] +[![License][license-shield]](LICENSE.md) + +![Project Maintenance][maintenance-shield] +[![GitHub Activity][commits-shield]][commits] + +[![Discord][discord-shield]][discord] +[![Community Forum][forum-shield]][forum] + +## Options + +| Name | Type | Requirement | Description +| ---- | ---- | ------- | ----------- +| type | string | **Required** | `custom:boilerplate-card` +| name | string | **Optional** | Card name +| show_error | boolean | **Optional** | Show what an error looks like for the card +| show_warning | boolean | **Optional** | Show what a warning looks like for the card + +## Starting a new card from boilerplate-card + +### Step 1 +Clone this repo + +### Step 2 +Install necessary modules +`yarn install` or `npm install` + +### Step 3 +Do a test lint & build on the project. You can see available scripts in the package.json +`npm run build` + +### Step 4 +Customize to suit your needs and contribute it back to the custom-cards org + +[Troubleshooting](https://github.com/thomasloven/hass-config/wiki/Lovelace-Plugins) + +[commits-shield]: https://img.shields.io/github/commit-activity/y/custom-cards/boilerplate-card.svg?style=for-the-badge +[commits]: https://github.com/custom-cards/boilerplate-card/commits/master +[discord]: https://discord.gg/5e9yvq +[discord-shield]: https://img.shields.io/discord/478094546522079232.svg?style=for-the-badge +[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg?style=for-the-badge +[forum]: https://community.home-assistant.io/c/projects/frontend +[license-shield]: https://img.shields.io/github/license/custom-cards/boilerplate-card.svg?style=for-the-badge +[maintenance-shield]: https://img.shields.io/badge/maintainer.svg?style=for-the-badge +[releases-shield]: https://img.shields.io/github/release/custom-cards/boilerplate-card.svg?style=for-the-badge +[releases]: https://github.com/custom-cards/boilerplate-card/releases