3942a116e4
First, it removes the documentation section from all the README.md files and instead puts a web-based godoc badge and link at the top with the other badges. This is being done since the local godoc tool no longer ships with Go by default, so the instructions no longer work without first installing godoc. Due to this, pretty much everyone uses the web-based godoc these days anyways. Anyone who has manually installed godoc won't need instructions. Second, it makes sure the ISC license badge is at the top with the other badges and removes the textual reference in the overview section. Finally, it's modifies the Installation section to Installation and Updating and adds a '-u' to the 'go get' command since it works for both and thus is simpler.
76 lines
2.8 KiB
Markdown
76 lines
2.8 KiB
Markdown
btcjson
|
|
=======
|
|
|
|
[]
|
|
(https://travis-ci.org/btcsuite/btcd) [![ISC License]
|
|
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
|
|
[]
|
|
(http://godoc.org/github.com/btcsuite/btcd/btcjson)
|
|
|
|
Package btcjson implements concrete types for marshalling to and from the
|
|
bitcoin JSON-RPC API. A comprehensive suite of tests is provided to ensure
|
|
proper functionality.
|
|
|
|
Although this package was primarily written for the btcsuite, it has
|
|
intentionally been designed so it can be used as a standalone package for any
|
|
projects needing to marshal to and from bitcoin JSON-RPC requests and responses.
|
|
|
|
Note that although it's possible to use this package directly to implement an
|
|
RPC client, it is not recommended since it is only intended as an infrastructure
|
|
package. Instead, RPC clients should use the
|
|
[btcrpcclient](https://github.com/btcsuite/btcrpcclient) package which provides
|
|
a full blown RPC client with many features such as automatic connection
|
|
management, websocket support, automatic notification re-registration on
|
|
reconnect, and conversion from the raw underlying RPC types (strings, floats,
|
|
ints, etc) to higher-level types with many nice and useful properties.
|
|
|
|
## Installation and Updating
|
|
|
|
```bash
|
|
$ go get -u github.com/btcsuite/btcd/btcjson
|
|
```
|
|
|
|
## Examples
|
|
|
|
* [Marshal Command]
|
|
(http://godoc.org/github.com/btcsuite/btcd/btcjson#example-MarshalCmd)
|
|
Demonstrates how to create and marshal a command into a JSON-RPC request.
|
|
|
|
* [Unmarshal Command]
|
|
(http://godoc.org/github.com/btcsuite/btcd/btcjson#example-UnmarshalCmd)
|
|
Demonstrates how to unmarshal a JSON-RPC request and then unmarshal the
|
|
concrete request into a concrete command.
|
|
|
|
* [Marshal Response]
|
|
(http://godoc.org/github.com/btcsuite/btcd/btcjson#example-MarshalResponse)
|
|
Demonstrates how to marshal a JSON-RPC response.
|
|
|
|
* [Unmarshal Response]
|
|
(http://godoc.org/github.com/btcsuite/btcd/btcjson#example-package--UnmarshalResponse)
|
|
Demonstrates how to unmarshal a JSON-RPC response and then unmarshal the
|
|
result field in the response to a concrete type.
|
|
|
|
## GPG Verification Key
|
|
|
|
All official release tags are signed by Conformal so users can ensure the code
|
|
has not been tampered with and is coming from the btcsuite developers. To
|
|
verify the signature perform the following:
|
|
|
|
- Download the public key from the Conformal website at
|
|
https://opensource.conformal.com/GIT-GPG-KEY-conformal.txt
|
|
|
|
- Import the public key into your GPG keyring:
|
|
```bash
|
|
gpg --import GIT-GPG-KEY-conformal.txt
|
|
```
|
|
|
|
- Verify the release tag with the following command where `TAG_NAME` is a
|
|
placeholder for the specific tag:
|
|
```bash
|
|
git tag -v TAG_NAME
|
|
```
|
|
|
|
## License
|
|
|
|
Package btcjson is licensed under the [copyfree](http://copyfree.org) ISC
|
|
License.
|