Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Rafay Ghafoor authored Sep 1, 2017
1 parent 6f6e85c commit 44d7362
Showing 1 changed file with 13 additions and 15 deletions.
28 changes: 13 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,6 @@
# PTCL-Router:
# PTCL-Router-API:

A PTCL-Router API.

# Current-Features:

- Obtain station information, showing their hostnames alongside for better readability (devices currently connected to the router).
- Obtain DHCP information.
- Block and unblock devices using their mac addresses.
- Block and unblock devices using their predefined aliases.
- Reboot router.
- Over-ride hostnames associated to the mac address with custom hostnames.
- Display blocked devices.
- Added two modes for blocking users ( CLI-MODE and SILENT-MODE (Default) ).
A PTCL-Router API to interact with default router interface.

# Usage:

Expand Down Expand Up @@ -50,8 +39,6 @@ Options:

# Examples:

**Shows devices connected to the router.**

```python
>>> python ptcl.py --configure # Configure router gateway, username and password
>>> python ptcl.py # Shows currently active devices.
Expand All @@ -64,6 +51,17 @@ Options:
>>> python ptcl.py -r # Reboots router.
```

# Current-Features:

- Obtain station information, showing their hostnames alongside for better readability (devices currently connected to the router).
- Obtain DHCP information.
- Block and unblock devices using their mac addresses.
- Block and unblock devices using their predefined aliases.
- Reboot router.
- Over-ride hostnames associated to the mac address with custom hostnames.
- Display blocked devices.
- Added two modes for blocking users ( CLI-MODE and SILENT-MODE (Default) ).

# TODO:

- [X] Writing documentation for API usage.
Expand Down

0 comments on commit 44d7362

Please sign in to comment.