diff --git a/README.md b/README.md index 0598a59..a31fb2d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ # SGSDist.jl +| **Documentation** | **Build Status** | +|:---------------------------------:|:------------------------------:| +| [![][docs-stable-img]][docs-stable-url] [![][docs-dev-img]][docs-dev-url] | [![][travis-img]][travis-url] | + `SGSDist.jl` is a Julia package that implements the stochastically generated skewed (SGS) distribution, a probability density function (pdf) obtained from the correlated additive and multiplicative (CAM) noise stochastic climate model developed by [Sura and Sardeshmukh (2008)](https://doi.org/10.1175/2007JPO3761.1) and [Sardeshmukh and Sura (2009)](https://doi.org/10.1175/2008JCLI2358.1). For more information on the form of the SGS distribution used in this package, see [Sardeshmukh et al. (2015)](https://doi-org.proxy.lib.fsu.edu/10.1175/JCLI-D-15-0020.1). @@ -28,8 +32,15 @@ using SGSDist ## Documentation -More thorough documentation is found by building the documentation located in `doc` locally with the `Documenter.jl` package. +- [**STABLE**][docs-stable-url] — **documentation of the most recently tagged version.** +- [**DEV**][docs-dev-url] — *documentation of the in-development version.* + + +[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg +[docs-dev-url]: https://brwst.github.io/SGSDist.jl/dev -## Project Status +[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg +[docs-stable-url]: https://brwst.github.io/SGSDist.jl/stable -This package is being developed and tested against Julia 1.0 and above. +[travis-img]: https://travis-ci.org/brwst/SGSDist.jl.svg?branch=master +[travis-url]: https://travis-ci.org/brwst/SGSDist.jl