From c50b9b201a46b1505c56d770ef0f498d1d519977 Mon Sep 17 00:00:00 2001
From: Orion Yeung <11580988+orionyeung001@users.noreply.github.com>
Date: Fri, 12 Apr 2024 17:43:59 -0500
Subject: [PATCH] chore: update badges and move examples to docs

---
 README.md  | 44 ++++----------------------------------------
 src/lib.rs | 46 +++++++++++++++++++++++++++++++++-------------
 2 files changed, 37 insertions(+), 53 deletions(-)

diff --git a/README.md b/README.md
index c6e59dbb..498bac97 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,9 @@
 # statrs
 
 ![tests](https://github.com/statrs-dev/statrs/actions/workflows/test.yml/badge.svg)
-[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.md)
-[![Crates.io](https://img.shields.io/crates/v/statrs.svg)](https://crates.io/crates/statrs)
+[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.md)]
+[![Crate](https://img.shields.io/crates/v/statrs.svg)](https://crates.io/crates/statrs)
+![docs.rs](https://img.shields.io/docsrs/statrs?style=for-the-badge).
 
 ## Current Version: v0.16.0
 
@@ -32,44 +33,7 @@ Add the most recent release to your `Cargo.toml`
 statrs = "0.16"
 ```
 
-## Examples
-
-Statrs comes with a number of commonly used distributions including Normal, Gamma, Student's T, Exponential, Weibull, etc.
-The common use case is to set up the distributions and sample from them which depends on the `Rand` crate for random number generation.
-
-```Rust
-use statrs::distribution::Exp;
-use rand::distributions::Distribution;
-
-let mut r = rand::rngs::OsRng;
-let n = Exp::new(0.5).unwrap();
-print!("{}", n.sample(&mut r));
-```
-
-Statrs also comes with a number of useful utility traits for more detailed introspection of distributions.
-
-```Rust
-use statrs::distribution::{Exp, Continuous, ContinuousCDF};
-use statrs::statistics::Distribution;
-
-let n = Exp::new(1.0).unwrap();
-assert_eq!(n.mean(), Some(1.0));
-assert_eq!(n.variance(), Some(1.0));
-assert_eq!(n.entropy(), Some(1.0));
-assert_eq!(n.skewness(), Some(2.0));
-assert_eq!(n.cdf(1.0), 0.6321205588285576784045);
-assert_eq!(n.pdf(1.0), 0.3678794411714423215955);
-```
-
-as well as utility functions including `erf`, `gamma`, `ln_gamma`, `beta`, etc.
-
-```Rust
-use statrs::statistics::Distribution;
-use statrs::distribution::FisherSnedecor;
-
-let n = FisherSnedecor::new(1.0, 1.0).unwrap();
-assert!(n.variance().is_none());
-```
+For examples, view the docs hosted on ![docs.rs](https://img.shields.io/docsrs/statrs?style=for-the-badge).
 
 ## Contributing
 
diff --git a/src/lib.rs b/src/lib.rs
index 7bd28c91..f8ddf9a4 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -5,23 +5,43 @@
 //! Math.NET in so far as they are used in the computation of distribution
 //! values. This crate depends on the `rand` crate to provide RNG.
 //!
-//! # Example
-//! The following example samples from a standard normal distribution
-//!
+//! # Sampling
+//! The common use case is to set up the distributions and sample from them which depends on the `Rand` crate for random number generation.
 //! ```
-//! # extern crate rand;
-//! # extern crate statrs;
+//! use statrs::distribution::Exp;
 //! use rand::distributions::Distribution;
-//! use statrs::distribution::Normal;
+//! let mut r = rand::rngs::OsRng;
+//! let n = Exp::new(0.5).unwrap();
+//! print!("{}", n.sample(&mut r));
+//! ```
+//!
+//! # Introspecting distributions
+//! Statrs also comes with a number of useful utility traits for more detailed introspection of distributions.
+//! ```
+//! use statrs::distribution::{Exp, Continuous, ContinuousCDF}; // `cdf` and `pdf`
+//! use statrs::statistics::Distribution; // statistical moments and entropy
+//!
+//! let n = Exp::new(1.0).unwrap();
+//! assert_eq!(n.mean(), Some(1.0));
+//! assert_eq!(n.variance(), Some(1.0));
+//! assert_eq!(n.entropy(), Some(1.0));
+//! assert_eq!(n.skewness(), Some(2.0));
+//! assert_eq!(n.cdf(1.0), 0.6321205588285576784045);
+//! assert_eq!(n.pdf(1.0), 0.3678794411714423215955);
+//! ```
+//!
+//! # Utility functions
+//! as well as utility functions including `erf`, `gamma`, `ln_gamma`, `beta`, etc.
+//!
+//! ```
+//! use statrs::distribution::FisherSnedecor;
+//! use statrs::statistics::Distribution;
 //!
-//! # fn main() {
-//! let mut r = rand::thread_rng();
-//! let n = Normal::new(0.0, 1.0).unwrap();
-//! for _ in 0..10 {
-//!     print!("{}", n.sample(&mut r));
-//! }
-//! # }
+//! let n = FisherSnedecor::new(1.0, 1.0).unwrap();
+//! assert!(n.variance().is_none());
 //! ```
+//! ## Distributions implemented
+//! Statrs comes with a number of commonly used distributions including Normal, Gamma, Student's T, Exponential, Weibull, etc. view all implemented in `distributions` module.
 
 #![crate_type = "lib"]
 #![crate_name = "statrs"]