Skip to content

Commit 7d8ea86

Browse files
committed
Updated readme
1 parent 24b3266 commit 7d8ea86

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

README.rst

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,26 @@ parallel-ssh uses asychronous network requests, there is *no* multi-threading or
88
.. image:: https://api.travis-ci.org/pkittenis/parallel-ssh.png?branch=master
99
:target: https://travis-ci.org/pkittenis/parallel-ssh
1010

11-
Module documentation can be found at the repository's `github pages`__
11+
Module documentation can be found at the repository's `github pages`_.
1212

13-
__ http://pkittenis.github.io/parallel-ssh
13+
.. _`github pages`: http://pkittenis.github.io/parallel-ssh
1414

1515
************
1616
Installation
1717
************
18-
To install gevent you need the libevent-dev package installed. Instructions below are for apt-get systems, substitute with your own package manager if necessary.
18+
19+
.. note ::
20+
libevent-dev package is no longer required as of gevent 1.0 which has migrated to libev. `parallel-ssh` now requires at least gevent version 1.0.
1921
2022
::
2123

22-
$ sudo apt-get install libevent-dev
23-
$ pip install parallel-ssh
24+
$ pip install parallel-ssh
25+
26+
**************
27+
Usage Examples
28+
**************
2429

25-
*************
26-
Usage Example
27-
*************
30+
See documentation on `github pages`_ for more complete examples
2831

2932
Run `ls` on two remote hosts in parallel.
3033

0 commit comments

Comments
 (0)