From 6ebadd786967b10c30043e9c7cf225829a574524 Mon Sep 17 00:00:00 2001
From: ConnorSkees <39542938+ConnorSkees@users.noreply.github.com>
Date: Sun, 1 Mar 2020 09:08:13 -0500
Subject: [PATCH] Add toplevel documentation

---
 src/lib.rs | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/src/lib.rs b/src/lib.rs
index f88c05d..5dadf58 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,3 +1,31 @@
+//! # grass
+//! An implementation of the sass specification in pure rust.
+//!
+//! All functionality is currently exposed through [`StyleSheet`].
+//!
+//! Spec progress as of 2020-03-01:
+//!
+//! | Passing | Failing | Total |
+//! |---------|---------|-------|
+//! | 1236    | 3857    | 5093  |
+//!
+//! ## Use as library
+//! ```
+//! use std::io::{BufWriter, stdout};
+//! use grass::{SassResult, StyleSheet};
+//!
+//! fn main() -> SassResult<()> {
+//!     let mut buf = BufWriter::new(stdout());
+//!     StyleSheet::from_path("input.scss")?.print_as_css(&mut buf)
+//! }
+//! ```
+//!
+//! ## Use as binary
+//! ```bash
+//! cargo install grass
+//! grass input.scss
+//! ```
+
 #![warn(
     clippy::all,
     clippy::restriction,