From b207c153791c69a971d687a78766c0abef87f566 Mon Sep 17 00:00:00 2001 From: Matthew Planchard Date: Sat, 21 Jan 2023 19:03:14 -0600 Subject: [PATCH] Update README and CHANGELOG for release --- CHANGELOG.md | 6 +++++- README.md | 4 +++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 96dbf76..5dd0fa5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [cuid 1.3.0], [cuid2 0.1.0] + ### Deprecated - The CUID v1 algorithm is now [deprecated](https://github.com/mplanchard/cuid-rust/issues/4), @@ -97,7 +99,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - CUID & CUID slug generation - Benchmark suite -[unreleased]: https://github.com/mplanchard/cuid-rust/compare/v1.2.0...HEAD +[unreleased]: https://github.com/mplanchard/cuid-rust/compare/cuid2-v0.1.0...HEAD +[cuid2 0.1.0]: https://github.com/mplanchard/cuid-rust/compare/v1.2.0...cuid2-v0.1.0 +[cuid 1.3.0]: https://github.com/mplanchard/cuid-rust/compare/v1.2.0...cuid-v1.3.0 [1.2.0]: https://github.com/mplanchard/cuid-rust/compare/v1.1.0...v1.2.0 [1.1.0]: https://github.com/mplanchard/cuid-rust/compare/v1.0.2...v1.1.0 [1.0.2]: https://github.com/mplanchard/cuid-rust/compare/v1.0.1...v1.0.2 diff --git a/README.md b/README.md index c3b20dc..dd3987b 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,9 @@ This repository is the home of the [cuid] and [cuid2] crates. The original CUID standard is marked as [deprecated](https://github.com/paralleldrive/cuid2#improvements-over-cuid) -in favor of CUID2, so please prefer the `cuid2` crate. +in favor of CUID2, so please prefer the `cuid2` crate. `cuid2` is provided as a +separate crate because its generated IDs have different semantics from `cuid`, +so it is not necessarily a drop-in replacement. If you are using the `cuid` crate already, you can also use the `cuid2()` function from that crate.