Skip to content
This repository has been archived by the owner on Nov 26, 2024. It is now read-only.

Commit

Permalink
Add readmes and update manifest
Browse files Browse the repository at this point in the history
  • Loading branch information
tcharding committed Jun 12, 2024
1 parent 0a8deae commit 840a981
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 4 deletions.
5 changes: 5 additions & 0 deletions client/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,14 @@ authors = [
"Tobin C. Harding <[email protected]>"
]
license = "CC0-1.0"
repository = "https://github.com/tcharding/rust-bitcoind-json-rpc"
description = "Bitcoin Core JSON-RPC client"
categories = ["cryptography::cryptocurrencies"]
keywords = ["bitcoin", "bitcoind", "json-rpc"]
readme = "../README.md"
edition = "2021"
rust-version = "1.56.1"
exclude = ["tests", "contrib"]

[features]
# Enable this feature to get a blocking JSON-RPC client.
Expand Down
13 changes: 13 additions & 0 deletions client/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# bitcoind-json-rpc-client

Rust client for the Bitcoin Core daemon's JSON-RPC API. Currently this
is only a blocking client and is intended to be used in integration testing.

## Minimum Supported Rust Version (MSRV)

This library should always compile with any combination of features on **Rust 1.56.1**.

## Licensing

The code in this project is licensed under the [Creative Commons CC0 1.0 Universal license](LICENSE).
We use the [SPDX license list](https://spdx.org/licenses/) and [SPDX IDs](https://spdx.dev/ids/).
5 changes: 5 additions & 0 deletions json/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,14 @@ authors = [
"Tobin C. Harding <[email protected]>"
]
license = "CC0-1.0"
repository = "https://github.com/tcharding/rust-bitcoind-json-rpc"
description = "Bitcoin Core JSON-RPC API types"
categories = ["cryptography::cryptocurrencies"]
keywords = ["bitcoin", "bitcoind", "json-rpc"]
readme = "../README.md"
edition = "2021"
rust-version = "1.56.1"
exclude = ["tests", "contrib"]

[features]
default = []
Expand Down
12 changes: 12 additions & 0 deletions json/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# bitcoind-json-rpc-types

Types returned by the JSON-RPC API of Bitcoin Core.

## Minimum Supported Rust Version (MSRV)

This library should always compile with any combination of features on **Rust 1.56.1**.

## Licensing

The code in this project is licensed under the [Creative Commons CC0 1.0 Universal license](LICENSE).
We use the [SPDX license list](https://spdx.org/licenses/) and [SPDX IDs](https://spdx.dev/ids/).
10 changes: 6 additions & 4 deletions regtest/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@
name = "bitcoind-json-rpc-regtest"
version = "0.1.0"
authors = ["Riccardo Casatta <[email protected]>", "Tobin C. Harding <[email protected]>"]
description = "Utility to run a regtest bitcoind process, useful in integration testing environments"
license = "MIT"
repository = "https://github.com/tcharding/rust-bitcoind-json-rpc"
documentation = "https://docs.rs/bitcoind-json-rpc-regtest/"
rust-version = "1.56.1"
edition = "2018"
description = "Utility to run a regtest bitcoind process, useful in integration testing environments"
categories = ["cryptography::cryptocurrencies", "development-tools::testing"]
keywords = ["bitcoin", "bitcoind", "json-rpc"]
readme = "../README.md"
edition = "2021"
rust-version = "1.56.1"
exclude = ["tests", "contrib"]

[dependencies]
bitcoind-json-rpc-client = { version = "0.1", features = ["client-sync"] }
Expand Down

0 comments on commit 840a981

Please sign in to comment.