Skip to content

Commit d44336e

Browse files
committed
docs: Update top-level crate docs
1 parent 1d649ce commit d44336e

File tree

1 file changed

+10
-4
lines changed
  • crates/stackable-versioned/src

1 file changed

+10
-4
lines changed

crates/stackable-versioned/src/lib.rs

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
1-
//! This crate enables versioning of structs (and enums in the future). It
2-
//! currently supports Kubernetes API versions while declaring versions on a
3-
//! data type. This will be extended to support SemVer versions, as well as
4-
//! custom version formats in the future.
1+
//! This crate enables versioning of structs and enums through procedural
2+
//! macros.
3+
//!
4+
//! Currently supported versioning schemes:
5+
//!
6+
//! - Kubernetes API versions (eg: `v1alpha1`, `v1beta1`, `v1`, `v2`), with
7+
//! optional support for generating CRDs.
8+
//!
9+
//! Support will be extended to SemVer versions, as well as custom version
10+
//! formats in the future.
511
//!
612
//! See [`versioned`] for an in-depth usage guide and a list of supported
713
//! parameters.

0 commit comments

Comments
 (0)