summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorVictor Stinner <victor.stinner@gmail.com>2014-11-21 13:39:49 +0100
committerVictor Stinner <victor.stinner@gmail.com>2014-11-21 13:39:49 +0100
commit4a0496fb5b9c95a1d265fcb64e94c25c4f877c51 (patch)
tree2216d914349eda9bfd6ca1e9e0b4c171ad96ac68 /README
parent44badca2e4bdc2fefac1049ba9a524a02b1f6e10 (diff)
downloadaioeventlet-4a0496fb5b9c95a1d265fcb64e94c25c4f877c51.tar.gz
documentation
Diffstat (limited to 'README')
-rw-r--r--README20
1 files changed, 4 insertions, 16 deletions
diff --git a/README b/README
index e128531..7e71364 100644
--- a/README
+++ b/README
@@ -1,29 +1,17 @@
-aiogreen implements the asyncio API (PEP 3156) on top of eventet. It makes
+aiogreen implements the asyncio API (PEP 3156) on top of eventlet. It makes
possible to write asyncio code in a project currently written for eventlet.
aiogreen allows to use greenthreads in asyncio coroutines, and to use asyncio
coroutines, tasks and futures in greenthreads: see ``link_future()`` and
``wrap_greenthread()`` functions.
-The main visible difference between trollius and aiogreen is that
+The main visible difference between aiogreen and trollius is the behaviour of
``run_forever()``: ``run_forever()`` blocks with trollius, whereas it runs in a
-greenthread with aiogreen. It means that it's possible to call
-``run_forever()`` in the main thread and execute other greenthreads in
-parallel.
-
-aiogreen:
+greenthread with aiogreen. It means that aiogreen event loop can run in an
+greenthread while the Python main thread runs other greenthreads in parallel.
* `aiogreen documentation <http://aiogreen.readthedocs.org/>`_
* `aiogreen project in the Python Cheeseshop (PyPI)
<https://pypi.python.org/pypi/aiogreen>`_
* `aiogreen project at Bitbucket <https://bitbucket.org/haypo/aiogreen>`_
* Copyright/license: Open source, Apache 2.0. Enjoy!
-
-Event loops:
-
-* `asyncio documentation <http://docs.python.org/dev/library/asyncio.html>`_
-* `trollus documentation <http://trollius.readthedocs.org/>`_
-* `eventlet documentation <http://eventlet.net/doc/>`_
-* `eventlet project <http://eventlet.net/>`_
-* `greenlet documentation <http://greenlet.readthedocs.org/>`_
-* `Tulip project <http://code.google.com/p/tulip/>`_