From d1b0f2ede72e1e8749b3bd869b0def3c4ac7bda2 Mon Sep 17 00:00:00 2001 From: Anthony Lavado Date: Wed, 21 Nov 2018 02:14:20 -0500 Subject: [PATCH] Update readme.md with wiki link again Update the readme to point at the wiki again, and change structure of readme to have more sections. Rewrote description of haaska slightly. --- README.md | 26 ++++++++++++++++++-------- 1 file changed, 18 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index fa0562f..6c44bcc 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,25 @@ -#### haaska: Home Assistant Alexa Skill Adapter +# haaska: Home Assistant Alexa Skill Adapter +[![Build Status](https://travis-ci.org/mike-grant/haaska.svg?branch=master)](https://travis-ci.org/mike-grant/haaska) +--- -## ATTENTION -The instructions are in the process of being updated. Until then, you can refer to [The Wanderer](http://collingwood.me.uk/blog/index.php/hass-io-and-alexa/) for steps. **Note that these instructions include steps for Hass.io, which may not apply to you. Skip that section if needed.** +haaska implements a bridge between the [Home Assistant Smart Home API](https://www.home-assistant.io/components/alexa/#smart-home) and the [Alexa Smart Home Skill API](https://developer.amazon.com/alexa/smart-home) from Amazon. ---- +This provides voice control for a connected home managed by Home Assistant, through any Alexa-enabled device. -haaska implements a bridge between a [Home Assistant](https://home-assistant.io) instance and the [Smart Home Skill API](https://developer.amazon.com/alexa/smart-home) for Amazon's Alexa. It provides voice control for a connected home managed by Home Assistant, through any Alexa-enabled device. +### Getting Started +To get started, head over to the [haaska Wiki](https://github.com/mike-grant/haaska/wiki). -For a list of available components that can be controlled [Home Assistant Docs](https://home-assistant.io/components/cloud.alexa/#available-domains) -(Thanks to [@bitglue](https://github.com/bitglue) for his work getting the smart home exposed via HTTP making this slimmed down version possible.) +### Thanks and Acknowledgement -[![Build Status](https://travis-ci.org/mike-grant/haaska.svg?branch=master)](https://travis-ci.org/mike-grant/haaska) +Thanks to [@auchter](https://github.com/auchter) for creating the original haaska. + +Thanks to [@bitglue](https://github.com/bitglue) for his work in getting the Smart Home API exposed via HTTP, making this slimmed down version possible. + +This fork of haaska was created by [@mike-grant](https://github.com/mike-grant). + +Documentation and additional maintenance is done by [@anthonylavado](https://github.com/anthonylavado), and contributors like you. + +### License +haaska is provided under the [MIT License](license.md).