diff --git a/README.md b/README.md index 7d42a94..e927022 100755 --- a/README.md +++ b/README.md @@ -42,3 +42,7 @@ The API is currently under heavy development. ``` +# TODO: + +- [ ] Writing documentation for the API usage. +- [ ] Writing unit tests for utilities module. \ No newline at end of file diff --git a/router.py b/router.py index 6805a7c..61fa72a 100755 --- a/router.py +++ b/router.py @@ -4,15 +4,17 @@ Usage Example: # router is used as an instance for the Router class in all examples. >>> from router import Router ->>> router = Router(gateway='192.168.1.1') # Launches session for interacting with router +>>> papi = Router(gateway='192.168.1.1') # Launches session for interacting with router >>> ->>> router.reboot() # Reboots router +>>> papi.reboot() # Reboots router ->>> router.stationinfo() # Returns a list of active devices +>>> papi.stationinfo() # Returns a list of active devices ['macxxx', 'macxxx2', 'macxx3'] ->>> router.dhcpinfo() # Returns a dictionary object for dhcpinfo +>>> papi.dhcpinfo() # Returns a dictionary object for dhcpinfo + {'HOSTNAME': ['Mac', 'LocalIp', 'Expires']} + {'my-computer': ['macxx', '192.168.10.1', '23 Hours, 59 Minutes']} ''' import re