From 3af4218a38ba9f21da69fc4965994ba8b4c52f8e Mon Sep 17 00:00:00 2001 From: Rodrigo Queiro Date: Thu, 12 Oct 2017 10:30:16 +0200 Subject: [PATCH] Improve README on voicekit branch (#145) I haven't restored the Travis badges as the build is failing on the voicekit branch. --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 57a68d34..678da7c6 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,8 @@ -This repository contains the APIs and demo apps for the AIYProjects. See -https://aiyprojects.withgoogle.com. +This repository contains an easy-to-use API for the AIY Voice Kit. +You can use it to create voice commands with simple while loops - have a look at the [demos](https://github.com/google/aiyprojects-raspbian/tree/voicekit/src). +Documentation is at the [AIY Projects site](https://aiyprojects.withgoogle.com). +For guidelines on contributing, look at CONTRIBUTING.md. + +For returning users: +The old voice-recognizer demo remains in the [master branch](https://github.com/google/aiyprojects-raspbian/tree/master) of this project. +The new code is in the `voicekit` branch, and is included in images starting with aiyprojects-2017-09-11.img.