commit 731932097b3ff15d09dd451212ebd23419dccf98
parent 80aeefe539538fabd19131225921649aa5a7b2d1
Author: triesap <tyson@radroots.org>
Date: Fri, 10 Apr 2026 00:54:27 +0000
events_codec: update metadata
Diffstat:
3 files changed, 26 insertions(+), 16 deletions(-)
diff --git a/crates/events_codec/Cargo.toml b/crates/events_codec/Cargo.toml
@@ -7,11 +7,11 @@ authors = [
]
rust-version.workspace = true
license.workspace = true
-description = "canonical encoders and decoders for radroots nostr event payloads"
+description = "Canonical event codecs and tag builders"
repository.workspace = true
homepage.workspace = true
documentation = "https://docs.rs/radroots_events_codec"
-readme.workspace = true
+readme = "README"
[features]
default = ["std"]
diff --git a/crates/events_codec/README b/crates/events_codec/README
@@ -0,0 +1,24 @@
+# radroots_events_codec
+
+This is the README for `radroots_events_codec`, which provides canonical event
+codecs and tag builders for the `radroots` core libraries.
+
+## Overview
+
+ * canonical decoders for event content, tags, job envelopes, profiles, and
+ wire representations;
+ * tag builder helpers for the same event families exposed by
+ `radroots_events`;
+ * parsed view and error types for codec-driven validation and routing;
+ * optional `serde_json` and `radroots_nostr` integration for JSON and wire
+ interop.
+
+## Copyright
+
+Except as otherwise noted, all files in the `radroots_events_codec`
+distribution are
+
+ Copyright (c) 2020-2026 Tyson Lupul
+
+For information on usage and redistribution, and for a DISCLAIMER OF ALL
+WARRANTIES, see LICENSE included in the `radroots_events_codec` distribution.
diff --git a/crates/events_codec/README.md b/crates/events_codec/README.md
@@ -1,14 +0,0 @@
-# radroots_events_codec
-
-Reference encoders and decoders for Rad Roots Nostr event payloads.
-
-## Goals
-
-- define stable encoding and decoding interfaces for Rad Roots event payloads
-- keep parsing and validation behavior deterministic across supported event forms
-- support std and no_std builds with feature-gated `serde_json` and Nostr integration
-- provide reusable codec primitives for higher-level Rad Roots crates
-
-## License
-
-Licensed under AGPL-3.0. See LICENSE.
