From f70a7d324f28e1cef9a0e0624a4bedb90e6daa1a Mon Sep 17 00:00:00 2001 From: Luke Childs Date: Fri, 9 Nov 2018 18:04:30 +0700 Subject: [PATCH] Add API docs --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 07e3a70..5869418 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,24 @@ buildOutputScript([['Lf8hucmupbtenQ3VPdxvvJ8gTfAsaon2gf', 100000000]]); // '0100e1f505000000001976a914da6473ed373e08f46dd8003fca7ba72fbe9c555e88ac' ``` +## API + +### buildOutputScript([[address, value], ...]); + +Returns a (hex string) P2PKH transaction output script. + +#### address + +Type: `string` + +A valid P2PKH address. + +#### value + +Type: `number` + +Value to send to `address` in satoshis. + ## License MIT © Luke Childs