Add an example with Reverse

README.md

@@ -23,8 +23,7 @@ Then use the data structure inside your Rust source code as in the following Exa
 
 Remember that, if you need serde support, you should compile using `--features serde`.
 
-## Example
-
+## Examples
 ```rust
 use priority_queue::PriorityQueue;
 
@@ -43,6 +42,26 @@ fn main() {
     }
 }
 ```
+By default, the highest priority element will be extracted first. The order can be easily reversed using the standard wrapper [`Reverse<T>`](https://doc.rust-lang.org/std/cmp/struct.Reverse.html).
+```rust
+use priority_queue::PriorityQueue;
+use std::cmp::Reverse;
+
+fn main() {
+    let mut pq = PriorityQueue::new();
+
+    assert!(pq.is_empty());
+    pq.push("Apples", Reverse(5));
+    pq.push("Bananas", Reverse(8));
+    pq.push("Strawberries", Reverse(23));
+
+    assert_eq!(pq.peek(), Some((&"Apples", &Reverse(5))));
+
+    for (item, _) in pq.into_sorted_iter() {
+        println!("{}", item);
+    }
+}
+```
 
 ## Speeding up
 

src/lib.rs

@@ -44,7 +44,7 @@
 //! For reverse order remember the standard wrapper
 //! [`Reverse<T>`](https://doc.rust-lang.org/std/cmp/struct.Reverse.html)
 //!
-//! # Example
+//! # Examples
 //! ```rust
 //! use priority_queue::PriorityQueue;
 //!
@@ -64,6 +64,28 @@
 //!     println!("{}", item);
 //! }
 //! ```
+//!
+//! Reverse ordering
+//! ```rust
+//! use priority_queue::PriorityQueue;
+//! use std::cmp::Reverse;
+//!
+//! fn main() {
+//!     let mut pq = PriorityQueue::new();
+//!
+//!     assert!(pq.is_empty());
+//!     pq.push("Apples", Reverse(5));
+//!     pq.push("Bananas", Reverse(8));
+//!     pq.push("Strawberries", Reverse(23));
+//!
+//!     assert_eq!(pq.peek(), Some((&"Apples", &Reverse(5))));
+//!
+//!     for (item, _) in pq.into_sorted_iter() {
+//!         println!("{}", item);
+//!     }
+//! }
+//! ```
+
 #![cfg_attr(not(feature = "std"), no_std)]
 
 #[cfg(not(feature = "std"))]