Skip to content

Commit

Permalink
updating README
Browse files Browse the repository at this point in the history
  • Loading branch information
Rafay Ghafoor committed Mar 31, 2018
1 parent 17692ee commit 917ac3a
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,7 @@ The API is currently under heavy development.

```

# TODO:

- [ ] Writing documentation for the API usage.
- [ ] Writing unit tests for utilities module.
10 changes: 6 additions & 4 deletions router.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 917ac3a

Please sign in to comment.