commit f40ffb825114d0c8c541ef3525d914cde4710e62
parent f1026d78618c69ad9fc1a4a2ca73bccedb9a1816
Author: triesap <tyson@radroots.org>
Date: Fri, 10 Apr 2026 01:00:06 +0000
types: update metadata
Diffstat:
2 files changed, 16 insertions(+), 9 deletions(-)
diff --git a/crates/types/Cargo.toml b/crates/types/Cargo.toml
@@ -10,7 +10,7 @@ license.workspace = true
description = "Shared type primitives for Radroots"
repository.workspace = true
homepage.workspace = true
-readme.workspace = true
+readme = "README"
build = "build.rs"
[features]
diff --git a/crates/types/README b/crates/types/README
@@ -1,14 +1,21 @@
# radroots_types
-Shared API result and error wrapper types for the Rad Roots SDK.
+This is the README for `radroots_types`, which provides shared result and error
+wrappers for the `radroots` core libraries.
-## Goals
+## Overview
-- define stable success and error envelope interfaces across SDK surfaces
-- keep envelope serialization behavior deterministic across API boundaries
-- support feature-gated type export for external SDK consumers
-- provide reusable wrapper primitives for higher-level Rad Roots crates
+ * `IError`, `IResult`, `IResultList`, and `IResultPass` wrapper types;
+ * small constructor helpers and status-label logic for pass and fail outcomes;
+ * optional `serde` and `ts-rs` support for API boundary serialization and
+ export;
+ * a compact support crate with no domain-specific business logic.
-## License
+## Copyright
-Licensed under AGPL-3.0. See LICENSE.
+Except as otherwise noted, all files in the `radroots_types` distribution are
+
+ Copyright (c) 2025 Tyson Lupul
+
+For information on usage and redistribution, and for a DISCLAIMER OF ALL
+WARRANTIES, see LICENSE included in the `radroots_types` distribution.