Skip to content

Commit

Permalink
chore: fix crates docs and metadata (#223)
Browse files Browse the repository at this point in the history
* chore(tap-core): fix docs README include

So that it works both with `cargo package` and `cargo docs`.

Signed-off-by: Alexis Asseman <alexis@semiotic.ai>

* chore: improve crates metadata

Signed-off-by: Alexis Asseman <alexis@semiotic.ai>

---------

Signed-off-by: Alexis Asseman <alexis@semiotic.ai>
  • Loading branch information
aasseman committed Mar 28, 2024
1 parent e72b276 commit 458658b
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 1 deletion.
1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
1 change: 1 addition & 0 deletions tap_aggregator/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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."

Expand Down
2 changes: 2 additions & 0 deletions tap_core/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
1 change: 1 addition & 0 deletions tap_core/README.md
2 changes: 1 addition & 1 deletion tap_core/src/lib.rs
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions tap_integration_tests/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 458658b

Please sign in to comment.