From 515c37d11023f21ffbbc646b9d5c4106337ee9d6 Mon Sep 17 00:00:00 2001
From: ConnorSkees <39542938+ConnorSkees@users.noreply.github.com>
Date: Sun, 19 Apr 2020 16:38:42 -0400
Subject: [PATCH] rearrange readme

---
 README.md | 35 ++++++++++++++++++++++++++---------
 1 file changed, 26 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index 18d424a..07eb378 100644
--- a/README.md
+++ b/README.md
@@ -2,16 +2,22 @@
 
 An implementation of the SASS spec in pure Rust
 
-To run the official test suite,
+This crate aims to provide a high level interface for compiling SASS into
+plain CSS. It offers a very limited API, currently exposing only 2 structs.
 
-```bash
-git clone https://github.com/connorskees/grass
-cd grass
-git submodule init
-git submodule update
-cargo b --release
-./sass-spec/sass-spec.rb -c './target/release/grass'
-```
+This crate also comes with a binary that is intended to act as an invisible
+replacement to the sass commandline executable.
+
+This crate aims to achieve complete feature parity with the dart-sass reference
+implementation. A deviation from the dart-sass implementation can be considered
+a bug except for in the following situations:
+ - Error messages
+ - Error spans
+ - Certain aspects of the indented syntax
+ - Potentially others in the future
+
+[Documentation](https://docs.rs/grass/)
+[crates.io](https://crates.io/crates/grass)
 
 The large features remaining are
 ```
@@ -27,6 +33,17 @@ a special parser for plain css
 string parsing/quoting/escaping (~200 tests)
 ```
 
+To run the official test suite,
+
+```bash
+git clone https://github.com/connorskees/grass
+cd grass
+git submodule init
+git submodule update
+cargo b --release
+./sass-spec/sass-spec.rb -c './target/release/grass'
+```
+
 ```
 2020-04-07
 PASSING: 2031