Merge pull request #15 from ayushanand18/readme-update

update: Updating README and Docs

README.md

@@ -1,8 +1,22 @@
 # PyDwcViz
-A python package to help with Darwin-Core Data analysis and visualization.
+A python package that makes Darwin-Core Data analysis and visualization easy.
 
 ## Installation
 ### Install latest development version from GitHub
 ```python
 pip install git+git://github.com/marinebon/py-dwc-viz.git
 ```
+
+## Modules
+Module | Description
+-------|------------
+`diversity`|Generate biodiversity indices for species analysis.
+`map`|Visualize DwC data easily on maps
+`stats`|Visualize distribution of records and environmental parameters.
+`taxon`|Visualize taxonomic distributions.
+
+## Documentation
+The documentation can be found at [GitHub Pages](https://marinebon.github.io/py-dwc-viz).
+
+## Authors
+Open-sourced and Built with ❤️ by MBON volunteers

docs/index.rst

@@ -25,26 +25,29 @@ Contents
 .. toctree::
    :maxdepth: 2
 
-   taxon
-   stats
    diversity
+   map
+   stats
+   taxon   
 
 Modules
 #######
-:ref:`taxon`
+:ref:`diversity`
 ----------------------
+Generate biodiversity indices for species analysis.
 
-Visualize taxanomic distributions from OBIS data in various forms.
+:ref:`map`
+-----------
+Visualize DwC data easily on maps.
 
 :ref:`stats`
 ----------------------
-
 Visualize distribution of records and environmental parameters from OBIS data in various forms.
 
-:ref:`diversity`
+:ref:`taxon`
 ----------------------
+Visualize taxanomic distributions from OBIS data in various forms.
 
-Generate biodiversity indices for species analysis.
 
 Indices and tables
 ==================

docs/map.rst

@@ -0,0 +1,10 @@
+.. _map:
+
+Map
+=====
+
+Visualize DwC data easily on maps.
+
+.. py:module:: pydwcviz.map
+
+.. autofunction:: points

pydwcviz/map/map.py

@@ -9,7 +9,7 @@ def points(df, crs="epsg:4326", figsize=(20,10)):
     Generate a point map from DwC data
 
     :param df: [DataFrame] A DwC data DataFrame with at least decimalLongitude, and decimalLatitude
-    as column labels
+        as column labels
     :param crs: [String] Define the CRS for the map
     :param figsize: [Tuple] Define the figsize of the plot