updated the changelog and readme

CHANGELOG.md

@@ -26,6 +26,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Renamed `gaps()` to `gaps_trimmed()` and added a `gaps_untrimmed()` method
 - Mass replaced renamed from the word "range" to the word "interval" all code
   items, docs.
+- The crate has been renamed from `discrete_range_map` to `nodit`
+- The `DiscreteRangeMap` is now `NoditMap` and the `DiscreteRangeSet` is now
+  `NoditSet`
 
 ### Fixed
 

Cargo.toml

@@ -4,9 +4,8 @@ version = "0.6.2"
 authors = ["James Forster <james.forsterer@gmail.com>"]
 edition = "2021"
 description = """
-This crate provides NoditMap and NoditSet, Data
-Structures for storing Non-Overlapping Discrete Intervals based off
-BTreeMap.
+This crate provides NoditMap and NoditSet, Non-Overlapping Discrete
+Interval Tree data-structures, which are based off BTreeMap.
 """
 documentation = "https://docs.rs/nodit"
 readme = "README.md"

README.md

@@ -9,8 +9,8 @@
 <img src="logo.png" alt="nodit_logo" width="350">
 </p>
 
-This crate provides [`NoditMap`] and [`NoditSet`], Data Structures for storing
-non-overlapping discrete intervals based off [`BTreeMap`].
+This crate provides [`NoditMap`] and [`NoditSet`], Non-Overlapping Discrete
+Interval Tree data-structures, which are based off [`BTreeMap`].
 
 `no_std` is supported and should work with the default features.
 
@@ -296,11 +296,20 @@ Lots of my inspiration came from the [`rangemap`] crate.
 The BTreeMap implementation ([`btree_monstrousity`]) used under the
 hood was inspired and forked from the [`copse`] crate.
 
-## Name Change
-
-This crate was previously named [`range_bounds_map`] it was renamed
+## Name Changes
+This crate was later named [`range_bounds_map`] it was renamed
 around about 2023-04-24 due to it no longer being an accurate name.
 
+This crate was previously named [`range_bounds_map`] it was renamed to
+[`discrete_range_map`] around about 2023-04-24 due to the old name no longer
+being very accurate.
+
+This crate was then renamed again on 2023-01-02 from [`discrete_range_map`] to
+[`nodit`] due to a change to prefer the word "interval" over "range" whenever
+possible for consistency. Hopefully, even if the library undergoes more changes
+the shorter and more abstract name may be able to be kept even if it loses its
+acronym of Non-Overlapping Discrete Interval Tree.
+
 ## Similar Crates
 
 Here are some relevant crates I found whilst searching around the

src/lib.rs

@@ -17,9 +17,8 @@ You should have received a copy of the GNU Affero General Public License
 along with nodit. If not, see <https://www.gnu.org/licenses/>.
 */
 
-//! This crate provides [`NoditMap`] and [`NoditSet`],
-//! Data Structures for storing non-overlapping discrete intervals based
-//! off [`BTreeMap`].
+//! This crate provides [`NoditMap`] and [`NoditSet`], Non-Overlapping Discrete
+//! Interval Tree data-structures, which are based off [`BTreeMap`].
 //!
 //! `no_std` is supported and should work with the default features.
 //!
@@ -55,8 +54,7 @@ along with nodit. If not, see <https://www.gnu.org/licenses/>.
 //!
 //! use nodit::interval::ie;
 //! use nodit::{
-//! 	DiscreteFinite, NoditMap, InclusiveInterval,
-//! 	Interval,
+//! 	DiscreteFinite, InclusiveInterval, Interval, NoditMap,
 //! };
 //!
 //! #[derive(Debug, Copy, Clone)]
@@ -236,7 +234,7 @@ along with nodit. If not, see <https://www.gnu.org/licenses/>.
 //! // returned by `get_entry_at_point()`, for example:
 //!
 //! use nodit::interval::uu;
-//! use nodit::{NoditMap, Interval};
+//! use nodit::{Interval, NoditMap};
 //!
 //! let map: NoditMap<
 //! 	WithInfinity<u8>,
@@ -382,14 +380,13 @@ extern crate alloc;
 pub(crate) mod utils;
 
 pub mod discrete_finite;
+pub mod interval;
 pub mod map;
 pub mod set;
-pub mod interval;
 
 pub use crate::discrete_finite::DiscreteFinite;
+pub use crate::interval::Interval;
 pub use crate::map::{
-	NoditMap, InclusiveInterval, IntervalType, OverlapError,
-	PointType,
+	InclusiveInterval, IntervalType, NoditMap, OverlapError, PointType,
 };
 pub use crate::set::NoditSet;
-pub use crate::interval::Interval;