Skip to content

Commit

Permalink
Update README and CHANGELOG for release
Browse files Browse the repository at this point in the history
  • Loading branch information
mplanchard committed Jan 22, 2023
1 parent 7040bf7 commit b207c15
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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),
Expand Down Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit b207c15

Please sign in to comment.