From 534b1cd239fb57933616f3d25ae258bdf708811d Mon Sep 17 00:00:00 2001 From: Fletcher Nichol Date: Sun, 12 Sep 2021 16:39:31 -0600 Subject: [PATCH] release: update CHANGELOG.md Signed-off-by: Fletcher Nichol --- CHANGELOG.md | 56 +++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 42 insertions(+), 14 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d6fe685..9f90267 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,37 +4,65 @@ ## [Unreleased] - ReleaseDate +> **Breaking Change Upgrade Note For Library Users** +> +> Due to the collapsing of a library crate and a binary/CLI crate into one +> crate, there is now a Cargo feature called `"application"` which is included +> in the default features. This allows for a clean `cargo install names`, +> resulting in a compilation and installation of the names CLI without any +> further options or flags. When using names as a library crate however, it is +> advised to now add `default-features = false` to the crate dependency in +> `Cargo.toml`. For example: +> +> ```toml +> [dependencies] +> names = { version = "0.12.0", default-features = false } +> ``` +> +> This will exclude the `clap` crate when being used in library/crate mode. + +### Changed + +- **(breaking):** collapse library and binary into 1 dual-purpose crate which + enables `cargo install names` to install the binary CLI +- **(breaking):** upgrade minimum supported Rust version to 1.46.0 +- upgrade to `rand` 0.8.4 +- upgrade to `clap` 3.0.0-beta.2 +- update codebase to Rust 2018 edition and idioms + +### Added + +- cross platform matrix testing +- binary artifacts on each release for Linux, macOS, Windows, & FreeBSD systems +- nightly releases + ## [0.11.0] - 2016-04-29 -### Breaking API changes +### Changed -- Move adjectives const to `names::ADJECTIVES`. ([@fnichol][]) -- Move nouns const to `names::NOUNS`. ([@fnichol][]) +- **(breaking):** move adjectives const to `names::ADJECTIVES` +- **(breaking):** move nouns const to `names::NOUNS` +- inline adjective and noun data from plaintext files -### Improvements +### Added -- (cli) Add color and suggestions features. ([@fnichol][]) -- Inline adjective and noun data from plaintext files. ([@fnichol][]) +- (cli): add color and suggestions features ## [0.10.0] - 2015-11-01 -### Breaking API changes - -- Use `Default` trait for Generator & Name types. ([@fnichol][]) - -### Improvements +### Changed -- (cli) Update usage output. ([@fnichol][]) +- **(breaking):** use `Default` trait for Generator & Name types +- (cli): update usage output ## [0.9.0] - 2015-09-15 The initial release. -[@fnichol]: https://github.com/fnichol - [unreleased]: https://github.com/fnichol/names/compare/v0.11.0...HEAD + [0.11.0]: https://github.com/fnichol/names/compare/v0.10.0...v0.11.0 [0.10.0]: https://github.com/fnichol/names/compare/v0.9.0...v0.10.0 [0.9.0]: https://github.com/fnichol/names/compare/f852f53...v0.9.0