Merge pull request #144 from proppy/readme-disclaimer

README: add versioning disclaimer, link to samples

Author: proppy

README.md

@@ -1,29 +1,22 @@
-# firebase-arduino
+# FirebaseArduino
 
 [![Build Status](https://travis-ci.org/googlesamples/firebase-arduino.svg?branch=master)](https://travis-ci.org/googlesamples/firebase-arduino)
 [![Join the chat at https://gitter.im/googlesamples/firebase-arduino](https://badges.gitter.im/googlesamples/firebase-arduino.svg)](https://gitter.im/googlesamples/firebase-arduino?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![Documentation Status](https://readthedocs.org/projects/firebase-arduino/badge/?version=latest)](http://firebase-arduino.readthedocs.io/en/latest/?badge=latest)
 
+This repo contains a collection of samples and an Arduino library that show how to call the [Firebase](https://www.firebase.com/) API from the [ESP8266 Arduino core](https://github.com/esp8266/Arduino).
 
-This sample shows how to call [Firebase](https://www.firebase.com/) from the [ESP8266 Arduino core](https://github.com/esp8266/Arduino).
+The Arduino library is [under heavy development](https://github.com/googlesamples/firebase-arduino/issues), **experimental**, **unversioned** and its API is **not stable**.
 
-## Requirements
+## Samples
 
-- 1 [ESP8266 Arduino board](https://www.adafruit.com/products/2821).
-- [Arduino 1.6.8](https://www.arduino.cc/en/Main/Software)
-- [stable ESP8266 Arduino board definition](https://github.com/esp8266/Arduino#installing-with-boards-manager)
+- [FirebaseDemo](https://github.com/googlesamples/firebase-arduino/tree/master/examples/FirebaseDemo_ESP8266) - shows the FirebaseArduino API methods.
+- [FirebaseRoom](https://github.com/googlesamples/firebase-arduino/tree/master/examples/FirebaseRoom_ESP8266) - shows how to push sensor data and trigger actuator from Firebase.
+- [FirebaseStream](https://github.com/googlesamples/firebase-arduino/tree/master/examples/FirebaseStream_ESP8266) - shows the FirebaseArduino streaming API.
 
-## Setup
+## Documentation
 
-- Clone the repo in your Arduino libraries directory.
-- open the `FirebaseDemo_ESP8266` example.
-- Replace `SSID` `PASSWORD` `example.firebaseio.com` `secret_or_token` placeholders.
-
-## Run
-
-- Open firebase dashboard on your database
-- Power up the arduino board.
-- Notice the changes being bad every seconds.
+- [FirebaseArduino API Reference](http://firebase-arduino.readthedocs.io/)
 
 ## Disclaimer