From 0e9e021ad7dd3cba645bfb8435a4ebf2c535b52a Mon Sep 17 00:00:00 2001 From: Torkel Rogstad Date: Thu, 21 Feb 2019 14:44:33 +0100 Subject: [PATCH] Updates READMEs for root, testkit and zmq (#356) --- README.md | 16 +++++++++++----- testkit/README.md | 4 +++- zmq/README.md | 3 +++ 3 files changed, 17 insertions(+), 6 deletions(-) create mode 100644 zmq/README.md diff --git a/README.md b/README.md index a5592750a6..9cb46599bf 100644 --- a/README.md +++ b/README.md @@ -15,15 +15,21 @@ 2. `core-test` - this is where all test cases for the `core` project live -3. `rpc` - this is a RPC client implementation for `bitcoind`. For more info read [`rpc/README.md`](rpc/README.md) +3. `bitcoind-rpc` - this is a RPC client implementation for `bitcoind`. For more info read [`bitcoind-rpc/README.md`](bitcoind-rpc/README.md) -4. `eclair-rpc` - this is a RPC client implementation for [Eclair](https://en.wikipedia.org/wiki/Algebraic_data_type), which is a Lightning Network implementation. For more information please read [`eclair-rpc/README.md`](eclair-rpc-README.md) +4. `bitcoind-rpc-test` - this is where all test cases for the `bitcoind-rpc` project live -5. `bench` - benchmarks for Bitcoin-S. For more information please read [`bench/README.md`](bench/README.md) +5. `eclair-rpc` - this is a RPC client implementation for [Eclair](https://en.wikipedia.org/wiki/Algebraic_data_type), which is a Lightning Network implementation. For more information please read [`eclair-rpc/README.md`](eclair-rpc/README.md) -6. `testkit` - This is a useful testkit for testing Bitcoin related applications. You can spin up Bitcoin and Lightning nodes arbitrarily and set them in specific states. For more information please read [`testkit/README.md`](testkit/README.md) +6. `eclair-rpc-test` - this is where all test cases for the `eclair-rpc` project live -7. `zmq` - `bitcoind` has a setting that publishes information about the state of the network over ZMQ. This project implements a subscriber that allows you to read and parse that information. For more information see [`zmq/README.md`](zmq/README.md) as well as the official [Bitcoin Core ZMQ documentation](https://github.com/bitcoin/bitcoin/blob/master/doc/zmq.md) +7. `bench` - benchmarks for Bitcoin-S. For more information please read [`bench/README.md`](bench/README.md) + +8. `testkit` - This is a useful testkit for testing Bitcoin related applications. You can spin up Bitcoin and Lightning nodes arbitrarily and set them in specific states. For more information please read [`testkit/README.md`](testkit/README.md) + +9. `zmq` - `bitcoind` has a setting that publishes information about the state of the network over ZMQ. This project implements a subscriber that allows you to read and parse that information. For more information see [`zmq/README.md`](zmq/README.md) as well as the official [Bitcoin Core ZMQ documentation](https://github.com/bitcoin/bitcoin/blob/master/doc/zmq.md) + +10. `secp256k1jni` - JNI (Java Native Interface) for [secp256k1](https://github.com/bitcoin-core/secp256k1), a optimized C library for EC operations on curve secp256k1. It has support for a wide range of cryptographic operations used in the Bitcoin protocol. Fore more information please read [`secp256k1jni/README.md`](secp256k1jni/README.md) ## Artifacts diff --git a/testkit/README.md b/testkit/README.md index 1fc56a89e0..702af39687 100644 --- a/testkit/README.md +++ b/testkit/README.md @@ -1 +1,3 @@ - [ ![Download](https://api.bintray.com/packages/bitcoin-s/bitcoin-s-core/bitcoin-s-testkit/images/download.svg) ](https://bintray.com/bitcoin-s/bitcoin-s-core/bitcoin-s-testkit/_latestVersion) +[ ![Download](https://api.bintray.com/packages/bitcoin-s/bitcoin-s-core/bitcoin-s-testkit/images/download.svg) ](https://bintray.com/bitcoin-s/bitcoin-s-core/bitcoin-s-testkit/_latestVersion) + +TODO diff --git a/zmq/README.md b/zmq/README.md new file mode 100644 index 0000000000..c63c71c90e --- /dev/null +++ b/zmq/README.md @@ -0,0 +1,3 @@ +[ ![Download](https://api.bintray.com/packages/bitcoin-s/bitcoin-s-core/bitcoin-s-zmq/images/download.svg) ](https://bintray.com/bitcoin-s/bitcoin-s-core/bitcoin-s-zmq/_latestVersion) + +TODO