Merge pull request #141 from proppy/readme-sample-2

examples: add README for Demo and Stream example.

Author: proppy

examples/FirebaseDemo_ESP8266/README.md

@@ -0,0 +1,31 @@
+# FirebaseDemo
+
+FirebaseDemo is a sample that shows basic usage of the `FirebaseArduino` API.
+
+## Software setup
+
+1. Install [Arduino 1.6.9](https://www.arduino.cc/en/Main/Software)
+1. Install [Arduino ESP8266 core](https://github.com/esp8266/Arduino#installing-with-boards-manager)
+1. Download [FirebaseArduino library](https://github.com/googlesamples/firebase-arduino/archive/master.zip)
+1. Start Arduino
+1. Click `Sketch > Include Library > Add .ZIP Library...`
+1. Choose `firebase-arduino-master.zip` downloaded in step `3.`
+
+## Configuration
+
+1. Go to https://www.firebase.com/ and create a new Firebase
+1. Copy the `Firebase Hostname`
+1. Go to `Secrets`
+1. Click `Firebase Secrets > Show`
+1. Copy the `Firebase Secret`
+1. Start Arduino
+1. Click `File > Examples > FirebaseArduino > FirebaseRoom_ESP8266`
+1. Replace `SSID` and `PASSWORD` with WiFi credentials
+1. Replace `example.firebaseio.com` with the `Firebase Hostname` from step `2.`
+1. Replace `secret_or_token` with `Firebase Secret` from step `5.`
+1. Click `Sketch > Upload`
+
+## Play
+
+1. Go to the Firebase console `Data` section
+1. Watch the data being modified as the sketch runs.

examples/FirebaseRoom_ESP8266/README.md

@@ -1,4 +1,7 @@
-# Firebase Room
+# FirebaseRoom
+
+FirebaseRoom is a sample that shows basic usage of FirebaseArduino to push
+sensor data to Firebase, and trigger actuators from Firebase.
 
 ## Software setup
 
@@ -24,10 +27,11 @@
 1. Go to https://www.firebase.com/ and create a new Firebase
 1. Copy the `Firebase Hostname`
 1. Go to `Secrets`
-1. Click `Firebase Secrets > Shows`
+1. Click `Firebase Secrets > Show`
 1. Copy the `Firebase Secret`
 1. Start Arduino
-1. Click `File > Examples > firebase-arduino > FirebaseRoom_ESP8266`
+1. Click `File > Examples > FirebaseArduino > FirebaseRoom_ESP8266`
+1. Replace `SSID` and `PASSWORD` with WiFi credentials
 1. Replace `example.firebaseio.com` with the `Firebase Hostname` from step `2.`
 1. Replace `secret_or_token` with `Firebase Secret` from step `5.`
 1. Click `Sketch > Upload`
@@ -40,7 +44,7 @@
 1. Same for `cooldown` and `brrr`
 1. Press the push button in the room
 1. Watch the `pushbutton` value change in the Firebase console
-1. Put your hand on the light sensor
+1. Put one hand on the light sensor
 1. Watch the `sunlight` value change in the Firebase console
 
 ## Homeworks

examples/FirebaseStream_ESP8266/README.md

@@ -0,0 +1,39 @@
+# FirebaseStream
+
+FirebaseStream is a sample that shows basic usage of the `FirebaseArduino`
+streaming API.
+
+It displays the current bitcoin price on a OLED screen as it gets updated on
+https://publicdata-cryptocurrency.firebaseio.com.
+
+## Hardware setup
+
+1. Get a [Feather Huzzah](https://www.adafruit.com/product/2821)
+1. Get a [FeatherWing OLED](https://www.adafruit.com/products/2900)
+1. Solder female headers on the `Feather Huzzah`.
+1. Solder mail headers on the `FeatherWing OLED`.
+1. Stack the `FeatherWing OLED` on top of the `Feather Huzzah`.
+
+## Software setup
+
+1. Install [Arduino 1.6.9](https://www.arduino.cc/en/Main/Software)
+1. Install [Arduino ESP8266 core](https://github.com/esp8266/Arduino#installing-with-boards-manager)
+1. Download [FirebaseArduino library](https://github.com/googlesamples/firebase-arduino/archive/master.zip)
+1. Start Arduino
+1. Click `Sketch > Include Library > Add .ZIP Library...`
+1. Choose `firebase-arduino-master.zip` downloaded in step `3.`
+1. Install the following libraries using `Sketch > Include Library > Manage Libraries...`:
+  - [Adafruit_GFX](https://github.com/adafruit/Adafruit-GFX-Library)
+  - [Adafruit_SSD1306](https://github.com/adafruit/Adafruit_SSD1306)
+
+## Configuration
+
+1. Start Arduino
+1. Click `File > Examples > FirebaseArduino > FirebaseStream_ESP8266`
+1. Replace `SSID` and `PASSWORD` with WiFi credentials
+1. Click `Sketch > Upload`
+
+## Play
+
+1. Watch the screen be updated with the current bitcoin price.
+1. Watch the data being modified as the sketch run.