Updated installation instructions to mention installing plugins.
@@ -13,6 +13,21 @@ The simplest way to install Cosmic Ray is with ``pip``:
This will install the most recent uploaded version in PyPI.
+Plugins
+-------
+
+A lot of Cosmic Ray's functionality is provided by plugins, and many of these
+plugins are not part of the core ``cosmic_ray`` package. Instead they are provided
+by other packages (some of which are included in the same git repository as
+``cosmic_ray``). Many of these can be installed with ``pip``.
+
+=========================== =========================================
+plugin command
+=========================== =========================================
+``pytest`` test runner ``pip install cosmic_ray_pytest_runner``
+``celery`` execution engine ``pip install cosmic-ray-celery3-engine``
+=========================== =========================================
+
From source
===========
@@ -35,20 +50,19 @@ modules they are supposed to test.
Plugins
=======
-A lot of Cosmic Ray's functionality is provided by plugins, and many of these
-plugins are not part of the core `cosmic_ray` package. Instead they are provided
-by other packages, some of which are included in the same git repository as
-`cosmic_ray`. The plugin packages which are included with the Cosmic Ray source
-repository can be found in the `plugins` directory.
+As mentioned above, much of Cosmic Ray's functionality is provided as plugins.
+Besides using ``pip``, you can also install these from source. The plugin
+packages which are included with the Cosmic Ray source repository can be found
+in the ``plugins`` directory.
For example, the Celery3 execution engine is provided as a plugin via the
-`cosmic_ray_celery3_engine` package. You can find this package in
-`plugins/execution-engines/celery3`, and you can install this plugin by running
+``cosmic_ray_celery3_engine`` package. You can find this package in
+``plugins/execution-engines/celery3``, and you can install this plugin by running
this command in that directory:
::
python setup.py install
-Other plugin packages can be found under the `plugins` directory, and it's
+Other plugin packages can be found under the ``plugins`` directory, and it's
likely that even more plugins will be available in other repositories.
