Skip to content

Commit 59cd0ec

Browse files
committed
adjust readme
1 parent 90fa46d commit 59cd0ec

File tree

2 files changed

+13
-9
lines changed

2 files changed

+13
-9
lines changed

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,17 @@
44
[![Crates.io](https://img.shields.io/crates/v/cuid2 "Crates.io")](https://crates.io/crates/cuid2/)
55
[![docs.rs](https://docs.rs/cuid/badge.svg)](https://docs.rs/cuid2/)
66

7-
This repository is the home of the [cuid] and [cuid2] crates. The original
8-
CUID standard is marked as [deprecated](https://github.com/paralleldrive/cuid2#improvements-over-cuid)
9-
in favor of CUID2, so please prefer the `cuid2` crate. `cuid2` is provided as a
10-
separate crate because its generated IDs have different semantics from `cuid`,
11-
so it is not necessarily a drop-in replacement.
12-
13-
If you are using the `cuid` crate already, you can also use the `cuid2()`
14-
function from that crate.
7+
This repository is the home of the [cuid] and [cuid2] crates. The
8+
original CUID standard is marked as [deprecated](https://github.com/paralleldrive/cuid2#improvements-over-cuid)
9+
in favor of CUID2, but we intent to continue supporting v1 CUIDs
10+
indefinitely, since their k-sortability is only insecure in specific
11+
use-cases, while their sortability is quite useful in other
12+
use-cases. `cuid2` is provided as a separate crate because its
13+
generated IDs have different semantics from `cuid`, so it is not
14+
necessarily a drop-in replacement.
15+
16+
If you are using the `cuid` crate already, you can also use `cuid2()`
17+
and related functions from that crate.
1518

1619
Please see the individual crates' READMEs for more information.
1720

crates/cuid1/src/lib.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,9 @@ mod time;
4242
pub use cuid1::{cuid, cuid1, cuid1_slug, is_cuid, is_cuid1, is_cuid1_slug, is_slug, slug};
4343
#[doc(hidden)]
4444
pub use cuid1::{one_off_cuid1, one_off_cuid1_slug};
45+
4546
pub use cuid2::{
46-
create_id as cuid2, is_cuid2, is_slug as is_cuid2_slug, slug as cuid2_slug,
47+
cuid as cuid2, is_cuid2, is_slug as is_cuid2_slug, slug as cuid2_slug,
4748
CuidConstructor as Cuid2Constructor,
4849
};
4950
pub use error::CuidError;

0 commit comments

Comments
 (0)