add readme

README.md

@@ -0,0 +1,39 @@
+# wenet-kws
+
+Production First and Production Ready End-to-End Keyword Spotting Toolkit.
+
+The goal of this toolkit it to...
+
+Small footprint keyword spotting (KWS), or specifically wake-up word (WuW) detection is a typical and important module in internet of things (IoT) devices.  It provides a way for users to control IoT devices with a hands-free experience. A WuW detection system usually runs locally and persistently on IoT devices, which requires low consumptional power, less model parameters, low computational comlexity and to detect predefined keyword in a streaming way, i.e., requires low latency.
+
+
+## Typical Scenario
+
+We are going to support the following typical applications of wakeup word:
+
+* Single wake-up word
+* Multiple wake-up words
+* Customizable wake-up word
+* Personalized wake-up word, i.e. combination of wake-up word detection and voiceprint
+
+## Dataset
+
+We plan to support a variaty of open source wake-up word datasets, include but not limited to:
+
+* [Hey Snips](https://github.com/sonos/keyword-spotting-research-datasets)
+* [Google Speech Command](https://arxiv.org/pdf/1804.03209.pdf)
+* [Hi Miya(你好米雅)](http://www.aishelltech.com/wakeup_data)
+* [Hi Xiaowen(你好小问)](http://openslr.org/87/)
+
+All the well-trained models on these dataset will be made public avaliable.
+
+
+## Runtime
+
+We plan to support a variaty of hardwares and platforms, including:
+
+* Web browser
+* x86
+* Android
+* Raspberry Pi
+