Skip to content

Commit

Permalink
docs: update usage in readme (#17)
Browse files Browse the repository at this point in the history
  • Loading branch information
dolcalmi authored May 27, 2023
1 parent 90aaf13 commit 9293f3d
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 3 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# bitcoin-cli-ts

Auto-generated Bitcoin client library for bitcoind json rpc api
Auto-generated Bitcoin client library for Bitcoin Core JSON-RPC API

## Installation

Expand All @@ -14,6 +14,10 @@ yarn add bitcoin-cli-ts

## Usage

Choose the [version](https://www.npmjs.com/package/bitcoin-cli-ts?activeTab=versions) that corresponds to your Bitcoin Core version.

We use the major and minor versions from [Bitcoin Core Releases](https://github.com/bitcoin/bitcoin/releases) and reserve the patch version for library fixes related to static code or dependencies.

### Config

```js
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "bitcoin-cli-ts",
"version": "24.1.0",
"description": "Auto-generated Bitcoin client library for bitcoind json rpc api",
"description": "Auto-generated Bitcoin client library for bitcoind JSON-RPC API",
"main": "dist/cjs/index.js",
"module": "dist/esm/index.js",
"types": "dist/types/index.d.js",
Expand Down Expand Up @@ -38,6 +38,7 @@
],
"keywords": [
"bitcoin",
"JSON-RPC",
"rpc",
"bitcoind",
"typescript",
Expand Down
2 changes: 1 addition & 1 deletion src/rpc/wallet/send-many.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ type SendManyParams = {
estimate_mode?: string
/* Specify a fee rate in sat/vB. */
fee_rate?: number | string
/* If true, return extra infomration about the transaction. */
/* If true, return extra information about the transaction. */
verbose?: boolean
}

Expand Down

0 comments on commit 9293f3d

Please sign in to comment.