fix last commit
[GitHub/Stricted/speedport-hybrid-php-api.git] / README.md
index 26ec482b41b3672ed5a050301da259724fb0ef5d..597266647f16b32e7566aed8a1efdb868a884592 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 ### speedport hybrid php api
 
-[![Build Status](https://travis-ci.org/Stricted/speedport-hybrid-php-api.svg)](https://travis-ci.org/Stricted/speedport-hybrid-php-api)
+[![Build Status](https://travis-ci.org/Stricted/speedport-hybrid-php-api.svg)](https://travis-ci.org/Stricted/speedport-hybrid-php-api) [![Release](https://img.shields.io/github/release/Stricted/speedport-hybrid-php-api.svg?style=flat-square)](https://github.com/Stricted/speedport-hybrid-php-api/releases/latest) [![License](https://img.shields.io/badge/license-LGPLv3-brightgreen.svg?style=flat-square)](https://github.com/Stricted/speedport-hybrid-php-api/blob/master/LICENSE)
 
 Access Speedport Hybrid Router through PHP
 
@@ -10,26 +10,55 @@ Access Speedport Hybrid Router through PHP
 ---
 This project is licensed under [GNU LESSER GENERAL PUBLIC LICENSE Version 3](https://github.com/Stricted/speedport-hybrid-php-api/blob/master/LICENSE).
 
-known valid paths for getData() :
- * /data/dsl.json
- * /data/interfaces.json
- * /data/arp.json
- * /data/session.json
- * /data/dhcp_client.json
- * /data/dhcp_server.json
- * /data/ipv6.json
- * /data/dns.json
- * /data/routing.json
- * /data/igmp_proxy.json
- * /data/igmp_snooping.json
- * /data/wlan.json
- * /data/module.json
- * /data/memory.json
- * /data/speed.json
- * /data/webdav.json
- * /data/bonding_client.json
- * /data/bonding_tunnel.json
- * /data/filterlist.json
- * /data/bonding_tr181.json
- * /data/letinfo.json
- * /data/Status.json
\ No newline at end of file
+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 `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