chore: fix crates docs and metadata (#223)

* chore(tap-core): fix docs README include So that it works both with `cargo package` and `cargo docs`. Signed-off-by: Alexis Asseman <[email protected]> * chore: improve crates metadata Signed-off-by: Alexis Asseman <[email protected]> --------- Signed-off-by: Alexis Asseman <[email protected]>
semiotic-ai · Mar 28, 2024 · 458658b · 458658b
1 parent e72b276
commit 458658b
Show file tree

Hide file tree

Showing 6 changed files with 7 additions and 1 deletion.
diff --git a/Cargo.toml b/Cargo.toml
@@ -6,3 +6,4 @@ members = ["tap_core", "tap_aggregator", "tap_integration_tests"]
 version = "0.1.0"
 edition = "2021"
 license = "Apache-2.0"
+repository = "https://github.com/semiotic-ai/timeline-aggregation-protocol"
diff --git a/tap_aggregator/Cargo.toml b/tap_aggregator/Cargo.toml
@@ -3,6 +3,7 @@ name = "tap_aggregator"
 version = "0.3.1"
 edition.workspace = true
 license.workspace = true
+repository.workspace = true
 readme = "README.md"
 description = "A JSON-RPC service for the Timeline Aggregation Protocol that lets clients request an aggregate receipt from a list of individual receipts."
 

diff --git a/tap_core/Cargo.toml b/tap_core/Cargo.toml
@@ -3,6 +3,8 @@ name = "tap_core"
 version = "1.0.0"
 edition.workspace = true
 license.workspace = true
+repository.workspace = true
+readme = "README.md"
 description = "Core Timeline Aggregation Protocol library: a fast, efficient and trustless unidirectional micro-payments system."
 
 [dependencies]

diff --git a/tap_core/README.md b/tap_core/README.md
@@ -0,0 +1 @@
+../README.md
diff --git a/tap_core/src/lib.rs b/tap_core/src/lib.rs
@@ -1,6 +1,6 @@
 // Copyright 2023-, Semiotic AI, Inc.
 // SPDX-License-Identifier: Apache-2.0
-#![doc = include_str!("../../README.md")]
+#![doc = include_str!("../README.md")]
 //! ## Getting started
 //!
 //! To get started with the TAP protocol, take a look on the [`manager`] module

diff --git a/tap_integration_tests/Cargo.toml b/tap_integration_tests/Cargo.toml
@@ -3,6 +3,7 @@ name = "tap_integration_tests"
 version = "0.1.10"
 edition.workspace = true
 license.workspace = true
+repository.workspace = true
 autotests = false
 description = "Integration tests for the Timeline Aggregation Protocol."
 publish = false