Docs more (#87)

* Finish up initial docs

* another addition

README.md

@@ -3,6 +3,7 @@
 [![License:MIT](https://img.shields.io/badge/License-MIT-lightgray.svg?style=flt-square)](https://opensource.org/licenses/MIT)
 [![pypi](https://img.shields.io/pypi/v/xarrayutils.svg)](https://pypi.org/project/xarrayutils)
 [![conda-forge](https://img.shields.io/conda/dn/conda-forge/xarrayutils?label=conda-forge)](https://anaconda.org/conda-forge/xarrayutils)
+[![Documentation Status](https://readthedocs.org/projects/xarrayutils/badge/?version=latest)](https://xarrayutils.readthedocs.io/en/latest/?badge=latest)
 
 
 # A collection of various tools for data analysis built on top of xarray and xgcm
@@ -11,29 +12,4 @@ This package contains a variety of utility functions I have used in the past few
 
 Please be aware that I am currently refactoring a lot of the code, which might cause breaking changes.
 
-Hopefully soon it will be better tested and documented.
-
-## Installation
-
-To install from source use pip:
-
-`pip install git+https://github.com/jbusecke/xarrayutils.git`
-
-> Make sure to install these packages to your environment `conda install astropy gsw cartopy`
-
-> In order to use dask > 2.0 you need the newest upstream xarray version. For xarray <= 0.14.1, please downgrade to dask < 2.0
-
-
-## Contents (not complete yet)
-
-### Converting between vertical coordinate systems
-
-`xarrayutils.vertical_coordinates` provides several tool to move between various vertical ocean grids, e.g. z, density, sigma or hybrid coordinates. See [this notebook](https://github.com/jbusecke/xarrayutils/blob/master/doc/vertical_coords.ipynb) for an early example.
-
-### Plotting utilities
-`xarrayutils.plotting` provides several small utility functions to make common tasks I find in my workflow in matplotlib easier. [Examples](doc/plotting.ipynb)
-
-### Utilities for large scale climate data analysis
-`xarrayutils.utils` provides some helpful tools to simplify common tasks in climate data
-analysis workflows. [This notebook](doc/utils.ipynb), provides some examples on how to
-use linear regression, work with multi-member data and seperate mixed layer values.
+For more information see the [documentation](https://xarrayutils.readthedocs.io/en/latest/)

docs/index.rst

@@ -6,7 +6,55 @@
 Welcome to xarrayutils's documentation!
 =======================================
 
-The most bestest introduction ever.
+This package contains a variety of utility functions I have used in the past few years for data analysis.
+
+Installation
+------------
+
+Installation from Conda Forge
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The easiest way to install xgcm along with its dependencies is via conda
+forge::
+
+ conda install -c conda-forge xarrayutils
+
+Installation from Pip
+^^^^^^^^^^^^^^^^^^^^^
+
+An alternative is to use pip::
+
+ pip install xarrayutils
+
+Installation from GitHub
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+You can get the newest version by installing directly from GitHub::
+
+ pip install git+https://github.com/xgcm/xgcm.git
+
+
+
+Contents
+--------
+
+Utilities for large scale climate data analysis
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+`xarrayutils.utils` provides some helpful tools to simplify common tasks in climate data
+analysis workflows.
+
+Plotting utilities
+^^^^^^^^^^^^^^^^^^
+
+`xarrayutils.plotting` provides several small utility functions to make common tasks I find in my workflow in matplotlib easier.
+
+Converting between vertical coordinate systems
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The utilities in `xarrayutils.vertical_coordinates` are superseeded by the new `xgcm transform module <https://xgcm.readthedocs.io/en/latest/transform.html>`_.
+
+
 
 .. toctree::
  :maxdepth: 2
@@ -15,6 +63,7 @@ The most bestest introduction ever.
  utils
  plotting
  api
+ whats-new