Update the documentation

Author: NicholasMamo

README.md

@@ -2,54 +2,93 @@
 
 # Multiplex
 
-Multiplex is a Python library that builds on matplotlib, providing new visualizations to help you explore your data and explain it better.
+Multiplex is a visualization library for Python built on [matplotlib](https://github.com/matplotlib/matplotlib/).
+Multiplex follows the principle that visualizations should tell a story in a beautiful way.
+This package is built with the intent of making it as easy as possible to transform data into beautiful visualizations.
 
-Creating narrative-driven visualizations involves re-imagining matplotlib's plots.
-Multiplex follows best-practices to help you create visualizations.
-The library adds the capability to add a description to visualizations and moves the legend to the top.
+> The instructions in this README.md file will get you a copy of the project up and running.
+> For use-cases of Multiplex, check out the [Jupyter Notebook examples](https://github.com/NicholasMamo/multiplex-plot/tree/master/examples).
+> To read more about Multiplex, read the [documentation](https://nicholasmamo.github.io/multiplex-plot/).
 
-In addition, Multiplex includes:
+## Who is Multiplex for?
 
-- A brand new text visualization modul to create text graphics or to annotate data anywhere on the plot,
-- A brand new graph visualization,
-- New matplotlib styles to make your data stand out.
+Multiplex is aimed at data scientists, researchers, students and all those who work with data and are familiar with Python.
+This library aims to make it easier to explore and explain data by creating beautiful visualizations.
 
-![Example time series](https://raw.githubusercontent.com/NicholasMamo/multiplex-plot/master/examples/exports/3-temperatures.png)
+## Why Multiplex?
+
+> If Multiplex is based on matplotlib, why not use matplotlib directly?
+
+Multiplex does not replace matplotlib.
+Anything that you can do with Multiplex, you can also do with matplotlib.
+What Multiplex does is make it easier to create beautiful visualizations.
+This is achieved by providing:
 
-The instructions in this README.md file will get you a copy of the project up and running.
-For use-cases of Multiplex, check out the Jupyter Notebook examples in the [examples](https://github.com/NicholasMamo/multiplex-plot/tree/master/examples) directory.
-To read more about Multiplex, read the [documentation](https://nicholasmamo.github.io/multiplex-plot/).
+* Custom matplotlib styles;
+* Functionality to caption visualizations;
+* Functionality to annotate any visualization with text; and
+* New types of visualizations not available in matplotlib, such as the network graph and text-based visualizations.
+
+## How do I use Multiplex?
 
 ### Prerequisites
 
 Multiplex is based on [matplotlib](https://github.com/matplotlib/matplotlib).
-You can install matplotlib using `python -m pip install -U matplotlib`.
+You can install matplotlib using pip: `python -m pip install -U matplotlib`.
 More details about it are available in [matplotlib's repository](https://github.com/matplotlib/matplotlib).
 
+Multiplex also uses the following libraries in certain visualizations:
+
+* [networkx](https://github.com/networkx/networkx)
+* [pandas](https://github.com/pandas-dev/pandas)
+
 ### Installing
 
-You can install Multiplex using `python -m pip install -U multiplex-plot`.
+You can install Multiplex using pip: `python -m pip install -U multiplex-plot`.
 
-## Running the tests
+### Creating visualizations
 
-The tests use [unittest](https://docs.python.org/3/library/unittest.html).
-Each visualization has its own unit tests.
-You can run the tests individually:
+Creating visualizations with Multiplex is very easy.
+For example, you can create a text visualization with a simple function call, including all styling options:
 
-```
-python3 -m unittest multiplex.tests.test_drawable
+```python
+	import matplotlib.pyplot as plt
+	from multiplex import drawable
+	plt.style.use(os.path.join(sys.path[0], '..', 'styles', "multiplex.style"))
+	viz = drawable.Drawable(plt.figure(figsize=(10, 2)))
+	paragraph = """Anthony Lopes is a Portuguese professional footballer who plays for Olympique Lyonnais as a goalkeeper. He came through the youth ranks at Lyon, being called to the first team in 2011 and making his debut the following year."""
+	style = { 'align': 'justify', 'fontfamily': 'serif', 'alpha': 0.9, 'lineheight': 1.25, 'lpad': 0.1, 'rpad': 0.1 }
+	viz.draw_text_annotation(paragraph, **style)
+	viz.set_title('Profile: Anthony Lopes', loc='left')
+	viz.set_caption("""Wikipedia is a useful repository to get more information about anything. Below is an excerpt from the Wikipedia profile of footballer Anthony Lopes.""")
+	plt.show()
 ```
 
-Or you can run the tests using the `tests.sh` script:
+![Example text annotation](https://raw.githubusercontent.com/NicholasMamo/multiplex-plot/master/examples/exports/2-simple-text.png)
 
-```
-chmod +x tests.sh
-./tests.sh
-```
+All it takes to draw a simple text visualization is 10 lines of code:
+
+1. Three lines to import matplotlib, Multiplex and the visualization style;
+2. Three lines to set up the visualization object, load the data and set the style;
+3. Four lines to draw and show the visualization, including a title and caption.
+
+Multiplex abstracts the tedious process of manually programming which elements go where, and lets you create beautiful visualizations with ease.
+
+For a quick start, check out the [Jupyter Notebook examples](https://github.com/NicholasMamo/multiplex-plot/tree/master/examples) for an easy-to-follow tour of Multiplex's capabilities.
+
+## Example visualizations
+
+![Example time series](https://raw.githubusercontent.com/NicholasMamo/multiplex-plot/master/examples/exports/3-temperatures.png)
+
+![Example time series](https://raw.githubusercontent.com/NicholasMamo/multiplex-plot/master/examples/exports/3-time-series.png)
+
+![Example network graph](https://raw.githubusercontent.com/NicholasMamo/multiplex-plot/master/examples/exports/4-marvel.png)
 
-## Built With
+## Built with
 
 * [matplotlib](https://github.com/matplotlib/matplotlib)
+* [networkx](https://github.com/networkx/networkx)
+* [pandas](https://github.com/pandas-dev/pandas)
 
 ## Versioning
 

docs/.doctrees/environment.pickle

@@ -24,7 +24,7 @@ Multiplex
 
 Multiplex is a visualization library for Python built on `matplotlib <https://github.com/matplotlib/matplotlib/>`_.
 Multiplex follows the principle that visualizations should tell a story in a beautiful way.
-This package is built with the intent of making it as easy as possible to transform data into beautiful visualizations.ons.
+This package is built with the intent of making it as easy as possible to transform data into beautiful visualizations.
 
 .. note::
 
@@ -65,8 +65,9 @@ What Multiplex does is make it easier to create beautiful visualizations.
 This is achieved by providing:
 
 - Custom matplotlib styles;
-- Functionality to caption visualizations, as well as annotate any visualization with text; and
-- New types of visualizations not available in matplotlib, such as the graph and text-based visualizations.
+- Functionality to caption visualizations;
+- Functionality to annotate any visualization with text; and
+- New types of visualizations not available in matplotlib, such as the network graph and text-based visualizations.
 
 For example, you can create a text visualization with a simple function call, including all styling options:
 

docs/.doctrees/index.doctree

@@ -173,7 +173,7 @@
 <h1>Multiplex<a class="headerlink" href="#multiplex" title="Permalink to this headline">¶</a></h1>
 <p>Multiplex is a visualization library for Python built on <a class="reference external" href="https://github.com/matplotlib/matplotlib/">matplotlib</a>.
 Multiplex follows the principle that visualizations should tell a story in a beautiful way.
-This package is built with the intent of making it as easy as possible to transform data into beautiful visualizations.ons.</p>
+This package is built with the intent of making it as easy as possible to transform data into beautiful visualizations.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>This website documents all of Multiplex’s functionality.
@@ -206,8 +206,9 @@ <h2>Why Multiplex?<a class="headerlink" href="#why-multiplex" title="Permalink t
 This is achieved by providing:</p>
 <ul class="simple">
 <li><p>Custom matplotlib styles;</p></li>
-<li><p>Functionality to caption visualizations, as well as annotate any visualization with text; and</p></li>
-<li><p>New types of visualizations not available in matplotlib, such as the graph and text-based visualizations.</p></li>
+<li><p>Functionality to caption visualizations;</p></li>
+<li><p>Functionality to annotate any visualization with text; and</p></li>
+<li><p>New types of visualizations not available in matplotlib, such as the network graph and text-based visualizations.</p></li>
 </ul>
 <p>For example, you can create a text visualization with a simple function call, including all styling options:</p>
 <div class="highlight-python notranslate"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre> 1