Skip to content
This repository was archived by the owner on Mar 17, 2025. It is now read-only.

Commit 997b436

Browse files
committed
README: add versioning disclaimer, link to samples
1 parent 7d476b8 commit 997b436

File tree

1 file changed

+9
-16
lines changed

1 file changed

+9
-16
lines changed

README.md

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,22 @@
1-
# firebase-arduino
1+
# FirebaseArduino
22

33
[![Build Status](https://travis-ci.org/googlesamples/firebase-arduino.svg?branch=master)](https://travis-ci.org/googlesamples/firebase-arduino)
44
[![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)
55
[![Documentation Status](https://readthedocs.org/projects/firebase-arduino/badge/?version=latest)](http://firebase-arduino.readthedocs.io/en/latest/?badge=latest)
66

7+
This repo contains a collection of sample and a library that shows how to call [Firebase](https://www.firebase.com/) from the [ESP8266 Arduino core](https://github.com/esp8266/Arduino).
78

8-
This sample shows how to call [Firebase](https://www.firebase.com/) from the [ESP8266 Arduino core](https://github.com/esp8266/Arduino).
9+
The Arduino library is [under heavy development](https://github.com/googlesamples/firebase-arduino/issues), **experimental**, **unversioned** and its API is **not stable**.
910

10-
## Requirements
11+
## Samples
1112

12-
- 1 [ESP8266 Arduino board](https://www.adafruit.com/products/2821).
13-
- [Arduino 1.6.8](https://www.arduino.cc/en/Main/Software)
14-
- [stable ESP8266 Arduino board definition](https://github.com/esp8266/Arduino#installing-with-boards-manager)
13+
- [FirebaseDemo](https://github.com/googlesamples/firebase-arduino/tree/master/examples/FirebaseDemo_ESP8266) - shows the FirebaseArduino API methods.
14+
- [FirebaseRoom](https://github.com/googlesamples/firebase-arduino/tree/master/examples/FirebaseRoom_ESP8266) - shows how to push sensor data and trigger actuator from Firebase.
15+
- [FirebaseStream](https://github.com/googlesamples/firebase-arduino/tree/master/examples/FirebaseStream_ESP8266) - shows the FirebaseArduino streaming API.
1516

16-
## Setup
17+
## Documentation
1718

18-
- Clone the repo in your Arduino libraries directory.
19-
- open the `FirebaseDemo_ESP8266` example.
20-
- Replace `SSID` `PASSWORD` `example.firebaseio.com` `secret_or_token` placeholders.
21-
22-
## Run
23-
24-
- Open firebase dashboard on your database
25-
- Power up the arduino board.
26-
- Notice the changes being bad every seconds.
19+
- [FirebaseArduino API Reference](http://firebase-arduino.readthedocs.io/)
2720

2821
## Disclaimer
2922

0 commit comments

Comments
 (0)