From 0d50df3fa9d5eb0398fabd5e6efd99e6065b0056 Mon Sep 17 00:00:00 2001 From: Luke Childs Date: Fri, 9 Nov 2018 20:20:53 +0700 Subject: [PATCH] Fix API docs --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d60adde..9764a1e 100644 --- a/README.md +++ b/README.md @@ -44,19 +44,25 @@ buildOutputScript([{address: 'Lf8hucmupbtenQ3VPdxvvJ8gTfAsaon2gf', value: 100000 ## API -### buildOutputScript(Array<[address, value]>) +### buildOutputScript(outputs) Returns a (hex string) P2PKH transaction output script. -#### address +#### outputs -Type: `string` +Type: `Array(output[, output])` + +An array of one or more output objects. + +##### output.address + +Type: `String` A valid P2PKH address. -#### value +##### output.value -Type: `number` +Type: `Number` Value to send to `address` in satoshis.