Jan-Philip Gehrcke avatar Jan-Philip Gehrcke committed c0beb4d

Update docs and README.

Comments (0)

Files changed (2)

 What can gipc do for you?
 =========================
-With ``gipc`` you can easily use ``multiprocessing`` and ``gevent`` within one
-Python application. It provides gevent-aware `multiprocessing.Process``-based
-child processes and gevent-cooperative inter-process communication.
+With ``gipc`` (pronunciation “gipsy”) child processes and gevent can
+easily be used within one Python application. ``gipc`` provides
+gevent-aware ``multiprocessing.Process``-based child processes and
+gevent-cooperative inter-process communication.
 
 
 Isn't this achievable with just gevent+multiprocessing?
 =======================================================
-Yes, but it requires some care:
-On Unix, child process creation via Python's ``multiprocessing`` package in the
-context of ``gevent`` might yield an undesired event loop state in the child
-and most likely breaks your application in some way. Furthermore, blocking
-method calls such as ``join()`` on a ``multiprocessing.Process`` or the
-``send()``/``recv()`` methods on a ``multiprocessing.Pipe`` are not
-gevent-cooperative. ``gipc`` hides and solves these problems for you in a
-straight-forward fashion and allows for simple integration of child processes
-in your application.
+Yes, but it requires care: On Unix, child process creation via Python's
+``multiprocessing`` package in the context of ``gevent`` might yield an
+undesired event loop state in the child and most likely breaks your application
+in some way. Furthermore, blocking method calls such as ``join()`` on a
+``multiprocessing.Process`` or the ``send()``/``recv()`` methods on a
+``multiprocessing.Connection`` are not gevent-cooperative. ``gipc`` overcomes
+these challenges  for you in a straight-forward fashion and allows for simple
+integration of child processes in your application -- on POSIX-compliant
+systems as well as on Windows.
 
 
 Documentation
 =============
-The documentation with API details, detailed installation instructions and
-requirements can be found online at http://gehrcke.de/gipc.
+The documentation with API details, installation instructions, requirements,
+and code examples can be found at http://gehrcke.de/gipc.
 
 
 Availability
 ============
-Download the latest release at `PyPI <http://pypi.python.org/pypi/gipc>`_  or
-download/clone the development version from the mercurial repository at
+Releases are available at `PyPI <http://pypi.python.org/pypi/gipc>`_.
+The development version can be received from the mercurial repository at
 `bitbucket <https://bitbucket.org/jgehrcke/gipc>`_.
 
 
 Author & license
 ================
-``gipc`` is written and maintained by`Jan-Philip Gehrcke <http://gehrcke.de>`_
-and is licensed under the `Apache License 2.0 <http://www.apache.org/licenses/LICENSE-2.0.txt>`_.
+``gipc`` is written and maintained by `Jan-Philip Gehrcke <http://gehrcke.de>`_
+and is licensed under the 
+`Apache License 2.0 <http://www.apache.org/licenses/LICENSE-2.0.txt>`_.
 
 
 Contact
 =======
 Your feedback is highly appreciated. You can contact me at
-jgehrcke@googlemail.com.
+jgehrcke@googlemail.com.
+
     download_url = "http://gehrcke.de/gipc",
     keywords = ["gevent", "ipc", "multiprocessing"],
     license = "Apache License 2.0",
+    platforms = ["POSIX", "Windows"],
     classifiers = [
         "Programming Language :: Python",
         "Development Status :: 3 - Alpha",
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.