Merge branch 'master' of github.com:pysal/splot

README.md

@@ -1,11 +1,11 @@
-[![Build Status](https://travis-ci.org/pysal/splot.svg?branch=master)](https://travis-ci.org/pysal/splot)
-
 # splot
 
 [![Build Status](https://travis-ci.org/pysal/splot.svg?branch=master)](https://travis-ci.org/pysal/splot)
 [![Coverage Status](https://coveralls.io/repos/github/pysal/splot/badge.svg?branch=master)](https://coveralls.io/github/pysal/splot?branch=master)
+[![Documentation Status](https://readthedocs.org/projects/pip/badge/?version=stable)](http://pip.pypa.io/en/stable/?badge=stable)
+[![PyPI version](https://badge.fury.io/py/splot.svg)](https://badge.fury.io/py/splot)
 
-**Lightweight plotting and mapping to facilitate spatial analysis with PySAL.**
+**Visual analytics for spatial analysis with PySAL.**
 
 ![Local Spatial Autocorrelation](figs/viz_local_autocorrelation.png)
 
@@ -18,9 +18,9 @@ If you are new to splot and PySAL you will best get started with our [documentat
 
 ## Installing splot
 
-### splot requires:
+### Installing dependencies:
 
-splot is compatible with `Python` 3.5 or later and depends on `geopandas` 0.4.0 or later and `matplotlib` 2.2.2 or later.
+splot is compatible with `Python` 3.6 and 3.7 and depends on `geopandas` 0.4.0 or later and `matplotlib` 2.2.2 or later.
 
 splot also uses
 * `numpy`
@@ -29,35 +29,40 @@ splot also uses
 * `Ipywidgets`
 
 Depending on your spatial analysis workflow and the PySAL objects you would like to visualize, splot relies on:
-* PySAL 2.0 2rc
-or separate packages:
+* PySAL 2.0
+
+or separate packages found in the PySAL stack:
 * esda
 * libpysal
 * spreg
 * giddy
 
-### Quick install:
+### Installing splot:
 
-There are two main ways of accessing splot. First, the overall library install of PySAL 2.0 includes splot.
-PySAL 2.0 will be available from PyPI or Anaconda by the beginning of September 2018:
+There are two ways of accessing splot. First, splot is installed with the [PySAL 2.0](https://pysal.readthedocs.io/en/latest/installation.html) metapackage through:
 
-    $ pip install pysal
+    $ pip install -U pysal
 
     or 
 
     $ conda install -c conda-forge pysal
 
 
-Second, splot can be installed separately. If you are using Anaconda, install splot via the conda utility:
+Second, splot can be installed as a separate package. If you are using Anaconda, install splot via the conda utility:
 
-    $ conda install -c conda-forge pysal
+    $ conda install -c conda-forge splot
 
 
 Otherwise you can install splot from PyPI with pip:
 
     $ pip install splot
 
 
+## Usage
+
+splot supports many different 
+https://github.com/pysal/splot/blob/master/notebooks/mapping_vba.ipynb
+
 ## Contributing to splot
 
 `splot` is an open source project within the Python Spatial Analysis Library that is supported by a community of Geographers, visualization lovers, map fans, users and data scientists. As a community we work together to create splot as our own spatial visualization toolkit and will gratefully and humbly accept any contributions and ideas you might bring into this project. 
@@ -69,13 +74,21 @@ Feel free to check out our dicussion spaces, add ideas and contributions:
 
 If you have never contributed before or you are just discovering what PySAL and splot have to offer, reading through """Doc-strings""" and correcting our Documentation can be a great way to start. Check for spelling and grammar mistakes or use [pep8](https://pypi.org/project/pep8/) and [pyflakes](https://pypi.org/project/pyflakes/) to clean our `.py` files. This will allow you to get used to working with [git](https://try.github.io) and generally allows you to familiarize yourself with the `splot` and `PySAL` code base.
 
-If you have already used PySAL and splot and you are missing object-specific views for your analysis feel free to add or discuss your ideas to our code-base. Please make sure you include unit test, documentation and examples or (create an issue so someone else can work together with you). The common `splot` API design discussed [here](https://github.com/pysal/splot/issues/9) can help you to decide how to best integrate your visualization prototype into `splot`.
+If you have already used PySAL and splot and you are missing object-specific views for your analysis feel free to add to our code-base or discuss your ideas. Please make sure you include unit test, documentation and examples or (create an issue so someone else can work together with you). The common `splot` API design discussed [here](https://github.com/pysal/splot/issues/9) can help you to decide how to best integrate your visualization prototype into `splot`.
+
+Beyond working on documentation and prototyping new visualizations, you can always write a bug report or feature request on [Github issues](https://github.com/pysal/splot/issues). Whether large or small, any contribution makes a big difference and we hope you enjoy being part of our community as much as we do! The only thing we ask is that you abide principles of openness, respect, and consideration of others as described in the [PySAL Code of Conduct](https://github.com/pysal/code_of_conduct/blob/master/README.md).
+
+## Road-map
+
+We are planning on extending splot's visualization toolkit in future. Functionality we plan to implement includes:
 
-Beyond working on documentation and prototyping new visualizations you can always write a bug report or feature request on [Github issues](https://github.com/pysal/splot/issues). Whether large or small, any contribution makes a big difference and we hope you enjoy beeing part of our community as much as we do!
+* visualisations for [density methods](https://github.com/pysal/splot/issues/32) (mapping density estimations)
+* [cross-hatching fill styles](https://github.com/pysal/splot/issues/35) for maps (to allow choropleth visualizations without class intervals)
+* [legendgrams](https://github.com/pysal/splot/issues/34) (map legends that visualize the distribution of observations by color in a given map)
 
+If you are interested in working on one of these or any other methods, check out the linked issues or get in touch! 
 
 ## Community support
 
 * [PySAL 2.0](http://pysal.org)
 * [Gitter chat splot](https://gitter.im/pysal/splot?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-* [Gitter chat pysal](https://gitter.im/pysal/pysal?)