Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
remcohaszing committed Mar 16, 2014
1 parent a645d7e commit 52f15fc
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 10 deletions.
17 changes: 8 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,28 +20,27 @@ As a python module

- Import the module

>>> import wakeonlan
>>> from wakeonlan import wol


- Wake up a single computer by its mac address

>>> wakeonlan.send_magic_packet('ff.ff.ff.ff.ff.ff')
>>> wol.send_magic_packet('ff.ff.ff.ff.ff.ff')


- Wake up multiple computers by their mac addresses.

>>> wakeonlan.send_magic_packet('ff.ff.ff.ff.ff.ff', '00-00-00-00-00-00',
... 'FFFFFFFFFFFF')
>>> wol.send_magic_packet('ff.ff.ff.ff.ff.ff', '00-00-00-00-00-00',
... 'FFFFFFFFFFFF')


- An external host may be specified. Do note that port forwarding on that host
is required. The default ip address is 255.255.255.255 and the default port
is 9.

>>> wakeonlan.send_magic_packet(
... 'ff.ff.ff.ff.ff.ff',
... ip_address='example.com',
... port=1337)
>>> wol.send_magic_packet('ff.ff.ff.ff.ff.ff',
... ip_address='example.com',
... port=1337)


As a standalone script
Expand Down Expand Up @@ -75,5 +74,5 @@ Licence
WTFPL


.. _GitHub:https://github.com/remcohaszing/pywakeonlan
.. _GitHub: https://github.com/remcohaszing/pywakeonlan
.. _Wikipedia: http://en.wikipedia.org/wiki/Wake-on-LAN
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

setup(
name='wakeonlan',
version='0.2.1',
version='0.2.2',
description='A small python module for wake on lan.',
url='https://github.com/remcohaszing/pywakeonlan',
author='Remco Haszing',
Expand Down

0 comments on commit 52f15fc

Please sign in to comment.