Merge pull request sekineh#21 from sekineh/v030

bump to v0.3.0.

Author: sekineh

CHANGELOG.md

@@ -6,6 +6,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.3.0] - 2020-07-08
+
 ### Added
 
 * Quickstart section in the doc

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "binary-heap-plus"
-version = "0.2.0"
+version = "0.3.0"
 authors = ["SEKINE, Hideki <sekineh@me.com>"]
 description = "Enhanced version of std::collections::BinaryHeap that supports max, min, and custom-order heaps."
 license = "MIT"
@@ -15,7 +15,7 @@ compare = "0.1.0"
 serde = { version = "1.0", optional = true, features = ["derive"] }
 
 [dev-dependencies]
-serde_json = "1.0.39"
+serde_json = "1.0.56"
 
 [badges]
 # TODO: waiting for PR to land...: https://github.com/rust-lang/crates.io/pull/1838#

README.md

@@ -4,28 +4,24 @@
 
 Enhancement over Rust's `std::collections::BinaryHeap`.
 
-It supports the following features and still maintains backward compatibility.
+It supports the following heaps and still maintains backward compatibility.
 - Max heap
+  - Use `BinaryHeap::new()` or `::with_capacity()`
 - Min heap
+  - Use `BinaryHeap::new_min()` or `::with_capacity_min()`
 - Heap ordered by closure
+  - Use `BinaryHeap::new_by()` or `::with_capacity_by()`
 - Heap ordered by key generated by closure
+  - Use `BinaryHeap::new_by_key()` or `::with_capacity_by_key()`
 
-Notable added method is:
-- `.into_iter_sorted()` backported from `std`.
+Other notable added methods are:
+- `BinaryHeap::from_vec_cmp()` and `BinaryHeap::from_vec()` for more generic construction.
+- `.into_iter_sorted()` which is less-surprising version of `.into_iter()`. The implementation is backported from `std`.
 
 ## MSRV (Minimum Supported Rust Version)
 
 This crate requires Rust 1.31.1 or later.
 
-## Note on `BinaryHeap::from_vec()`
-
-Currently, the `From<Vec<T>>` trait is implemented for max heap only.
-If you add generic impl for other heaps, the existing code breaks, requires 
-slight modification such as type annotation.
-
-To maintain good compatibility with `std` version, `::from_vec()` method was added
-for the same purpose.
-
 # Changes
 
 See CHANGELOG.md.