Updated crate doc introduction.

Fixes #170.
pest-parser · Sep 30, 2018 · 9c52c2a · 9c52c2a
1 parent 0d14526
commit 9c52c2a
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 6 deletions.
diff --git a/derive/src/lib.rs b/derive/src/lib.rs
@@ -9,11 +9,27 @@
 
 //! # pest. The Elegant Parser
 //!
-//! pest is a [PEG](https://en.wikipedia.org/wiki/Parsing_expression_grammar) parser built with
-//! *simplicity* and *speed* in mind.
+//! pest is a general purpose parser written in Rust with a focus on accessibility, correctness,
+//! and performance. It uses parsing expression grammars (or [PEG]) as input, which are similar in
+//! spirit to regular expressions, but which offer the enhanced expressivity needed to parse
+//! complex languages.
 //!
-//! This crate works in conjunction with the [`pest` crate](https://docs.rs/pest) by
-//! deriving a grammar implementation based on a provided grammar.
+//! [PEG]: https://en.wikipedia.org/wiki/Parsing_expression_grammar
+//!
+//! ## Getting started
+//!
+//! The recommended way to start parsing with pest is to read the official [book].
+//!
+//! Other helpful resources:
+//!
+//! * API reference on [docs.rs]
+//! * play with grammars and share them on our [fiddle]
+//! * leave feedback, ask questions, or greet us on [Gitter]
+//!
+//! [book]: https://pest-parser.github.io/book
+//! [docs.rs]: https://docs.rs/pest
+//! [fiddle]: https://pest-parser.github.io/#editor
+//! [Gitter]: https://gitter.im/dragostis/pest
 //!
 //! ## `.pest` files
 //!

diff --git a/pest/src/lib.rs b/pest/src/lib.rs
@@ -9,8 +9,27 @@
 
 //! # pest. The Elegant Parser
 //!
-//! pest is a [PEG](https://en.wikipedia.org/wiki/Parsing_expression_grammar) parser built with
-//! *simplicity* and *speed* in mind.
+//! pest is a general purpose parser written in Rust with a focus on accessibility, correctness,
+//! and performance. It uses parsing expression grammars (or [PEG]) as input, which are similar in
+//! spirit to regular expressions, but which offer the enhanced expressivity needed to parse
+//! complex languages.
+//!
+//! [PEG]: https://en.wikipedia.org/wiki/Parsing_expression_grammar
+//!
+//! ## Getting started
+//!
+//! The recommended way to start parsing with pest is to read the official [book].
+//!
+//! Other helpful resources:
+//!
+//! * API reference on [docs.rs]
+//! * play with grammars and share them on our [fiddle]
+//! * leave feedback, ask questions, or greet us on [Gitter]
+//! 
+//! [book]: https://pest-parser.github.io/book
+//! [docs.rs]: https://docs.rs/pest
+//! [fiddle]: https://pest-parser.github.io/#editor
+//! [Gitter]: https://gitter.im/dragostis/pest
 //!
 //! ## Usage
 //!