Merge pull request #95 from sharmapulkit04/pr1

Updated documentation

Author: kevin-wangzefeng

README.md

@@ -10,10 +10,12 @@ IOT releated examples need extra devices, like Raspberry and so on.
 |Name | Description |
 |---|---|
 |  [LED-RaspBerry-Pi](led-raspberrypi/README.md)     |Controlling a LED light with Raspberry Pi using KubeEdge platform
-|[Data Analysis @ Edge](KE-Apache-Beam-Analysis/README.md) | Analyzing data at edge by using Apache Beam and KubeEdge
+|[Data Analysis @ Edge](apache-beam-analysis/README.md) | Analyzing data at edge by using Apache Beam and KubeEdge
 | [Security@Edge](security-demo/README.md) | Security at edge using SPIRE for identity management
 [Bluetooth-CC2650-demo](bluetooth-CC2650-demo/README.md)     |Controlling a CC2650 SensorTag bluetooth device using KubeEdge platform
-| [Play Music @Edge through WeChat](kubeedge-wechat-demo/README.md) | Play music at edge based on WeChat and KubeEdge
-| [Play Music @Edge through Web](kubeedge-web-demo/README.md) | Play music at edge based on Web and KubeEdge
-| [Collecting temperature @Edge](kubeedge-temperature-demo/README.md) | Collecting temperature at edge based KubeEdge
+| [Play Music @Edge through WeChat](wechat-demo/README.md) | Play music at edge based on WeChat and KubeEdge
+| [Play Music @Edge through Web](web-demo/README.md) | Play music at edge based on Web and KubeEdge
+| [Collecting temperature @Edge](temperature-demo/README.md) | Collecting temperature at edge based KubeEdge
 | [Control pseudo device counter and collect data](kubeedge-counter-demo/README.md) | Control pseudo device counter and collect data based KubeEdge
+  [Play Music @Edge through Twitter](ke-twitter-demo/README.md)| Play music at edge based on Twitter and KubeEdge. 
+  [Control Zigbee @Edge through cloud](kubeedge-edge-ai-application/README.md) | Face detection at cloud using OpenCV and using it to control zigbee on edge using Kubeedge.

kubeedge-edge-ai-application/README.md

@@ -3,7 +3,7 @@
 This demo contains two general modules: AI algorithm module and a zigbee device module.
 ## Prerequisites  
 ### Hardware Prerequisites  
-1. CC2531 USB sniffer with firmware has been refreshe
+1. CC2531 USB sniffer with firmware been refreshed
 <img src="./image/cc2531.jpg" width=256 height=256 />
 2. Xiao Mi zigbee power plug ZNCZ02LM
 <img src="./image/switch.jpg" width=256 height=256 />  
@@ -15,19 +15,21 @@ This demo contains two general modules: AI algorithm module and a zigbee device
 ## Steps to reproduce
 1. Clone the project 
 2. Run KubeEdge
-### AI algorithm moudel
+### AI algorithm module
 #### Face recognition    
-``` $ cd face-recong  
+``` 
+    $ cd face-recong  
     $ docker build -t face-recon:dev  
     $ cd ..
-    $ kubectl apply -f faceReconDeplloyment.yaml
+    $ kubectl apply -f faceReconDeployment.yaml
  ```  
 1. Calling the camera defaults to a local camera, and you can change the IP address of the camera by using `-- camera = ip:port`  
 2. You can add the `--show` parameter to determine whether the recognition results are displayed on the display.  
 3. When adding the `--show` parameter, you can pass in face data via the S key on the keyboard  
 4. Copy the model to the local `/model/facenet` directory before running it
 #### Moving object detection  
-``` $ cd motion detection  
+``` 
+    $ cd motion detection  
     $ docker build -t motion-detection:dev 
     $ cd ..
     $ kubectl apply -f motionDetectionDeployment.yaml
@@ -36,22 +38,26 @@ This demo contains two general modules: AI algorithm module and a zigbee device
 2. When a moving object appears in front of the camera, the program will record the video and save the result to the local directory /data/video
 ### Device module
 #### Device & DeviceModel
-``` $ cd crds
+``` 
+    $ cd crds
     $ kubectl apply -f devicemodel.yaml
     $ kubectl apply -f device.yaml
  ```    
 When the device is connected, you can view the results of the cloud device synchronization through the following command
-``` $ kubectl get device switch -oyaml -w
-```   
+``` 
+    $ kubectl get device switch -oyaml -w 
+```  
 #### zigbee2mqtt  
-``` $ cd zigbee2mqtt
+``` 
+    $ cd zigbee2mqtt
     $ docker build -t zigbee2mqtt:v1 .
     $ cd ..
     $ kubectl apply -f deployzigbee2mqtt.yaml
 ```
 1. Make sure cc2531 USB Sniffer is connected to your device and there is a directory `/dev/ttyacm0`
 #### mapper
-``` $ cd mapper
+``` 
+    $ cd mapper
     $ docker build -t mapper:v1 .
     $ kubectl apply -f deployMapper.yaml  
 ```