Added a couple of sections to the readme.

MultiQC · May 17, 2018 · d51d56d · d51d56d
1 parent 1fa4aed
commit d51d56d
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -17,6 +17,14 @@ https://gitter.im/ewels/MultiQC
 
 ---
 
+### When to write a plugin
+
+This example plugin contains both custom code and a MultiQC module for parsing content into reports.
+
+MultiQC modules can either be written as part of the core MultiQC program, or in a stand-alone plugin. If your module is for a publicly available tool, **please add it to the main program** and contribute your code via a pull request (see the [contributing instructions](https://github.com/ewels/MultiQC/blob/master/.github/CONTRIBUTING.md)).
+
+If your module is for something very niche, which no-one else can use, then it's best to write it as part of a custom plugin. The process is almost identical, though it keeps the code bases separate.
+
 ### Overview of files
 
 * `setup.py`
@@ -35,6 +43,17 @@ https://gitter.im/ewels/MultiQC
 * `example_plugin/modules/my_example/`
     * This folder contains a minimal MultiQC module which will execute along with all other MultiQC modules (as defined by the `setup.py` hook).
 
+### Usage
+
+To use this code, you need to install MultiQC and then your code. For example:
+
+```bash
+pip install MultiQC
+python setup.py install
+```
+
+Use `python setup.py develop` if you're actively working on the code - then you don't need to rerun the installation every time you make an edit _(though you still do if you change anything in `setup.py`)_.
+
 ### Disabling the plugin
 
 In this example plugin, I have defined a single additional command line flag - `--disable-example-plugin`. When specified, it sets a new MultiQC config value to `True`. This is checked in every plugin function; the function then returns early if it's `True`.