fix reconnectLte

[GitHub/Stricted/speedport-hybrid-php-api.git] / README.md

diff --git a/README.md b/README.md
index 99b3af01cb24acc217710d2eb8885aca823624fa..f046add56fdf55085326d1ba0e7dbb6642bb906f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,3 +1,69 @@
-## speedport hybrid php api
+### speedport hybrid php api
 
-Access Speedport Hybrid Router through PHP
\ No newline at end of file
+[![Build Status](https://travis-ci.org/Stricted/speedport-hybrid-php-api.svg?branch=master)](https://travis-ci.org/Stricted/speedport-hybrid-php-api) [![Release](https://img.shields.io/github/release/Stricted/speedport-hybrid-php-api.svg)](https://github.com/Stricted/speedport-hybrid-php-api/releases/latest) [![License](https://img.shields.io/badge/license-LGPLv3-brightgreen.svg)](https://github.com/Stricted/speedport-hybrid-php-api/blob/master/LICENSE)
+
+Access Speedport Hybrid Router through PHP
+
+**THIS CLASS IS ONLY FOR SPEEDPORT HYBRID**
+
+### License
+---
+This project is licensed under [GNU LESSER GENERAL PUBLIC LICENSE Version 3](https://github.com/Stricted/speedport-hybrid-php-api/blob/master/LICENSE).
+
+known endpoints for getData() and sentRequest():
+
+| Endpoint       |
+| -------------- |
+| dsl            |
+| interfaces     |
+| arp            |
+| session        |
+| dhcp_client    |
+| dhcp_server    |
+| ipv6           |
+| dns            |
+| routing        |
+| igmp_proxy     |
+| igmp_snooping  |
+| wlan           |
+| module         |
+| memory         |
+| speed          |
+| webdav         |
+| bonding_client |
+| bonding_tunnel |
+| filterlist     |
+| bonding_tr181  |
+| lteinfo        |
+| status         |
+| Connect        |
+| WLANBasic      |
+| WLANAccess     |
+| LAN            |
+| NASLight       |
+| INetIP         |
+| FilterAndTime  |
+| Portforwarding |
+| PhoneBook      |
+| PhoneCalls     |
+| SystemMessages |
+| DynDNS         |
+| Overview       |
+
+PHP requirements
+============= 
+ * PHP >= 5.4.0
+ * PHP extension `hash`
+ * PHP extension `curl`
+ * PHP extension `json`
+ * PHP extension `pcre`
+ * PHP extension `ctype`
+ * PHP extension `rrd` (optional, for rrd graphs)
+
+rrdtool integration
+=============
+
+![dsl status](assets/dsl-1h.png)
+![lte status](assets/lteinfo-1h.png)
+
+See the ```rrd``` directory for sample scripts.
\ No newline at end of file