Update index.rst

Add a small description to the documentation
Phlya · May 20, 2018 · 1d931b1 · 1d931b1
1 parent be4c265
commit 1d931b1
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -11,7 +11,10 @@ Welcome to the documentation for adjustText!
    :caption: Contents:
    ../examples/Examples.ipynb
 
+adjustText is a small library to help you adjust text positions on matplotlib plots to remove or minimize overlaps with each other and data points. The approach is based on overlaps of bounding boxes and iteratively moving them to reduce overlaps. The idea is from the ggrepel package for R/ggplot2 (https://github.com/slowkow/ggrepel).
 
+The repository with the issue tracker can be found here: https://github.com/Phlya/adjustText/
+Please see usage examples here: https://github.com/Phlya/adjustText/blob/master/examples/Examples.ipynb
 
 Indices and tables
 ==================