From f952a2ac7ba1a3de705bdb2a9e14d9e5066d3c5b Mon Sep 17 00:00:00 2001 From: Adam Lockhart Date: Mon, 25 Apr 2016 23:08:53 +0000 Subject: [PATCH] Updated documentation --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bd317fe..b4af643 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ ## ChangeDispenserController Class +Provides a simple API for the veding machine change dispenser. ### Methods #### calculateChange(unitsTendered, price) @@ -7,7 +8,7 @@ **price:** Number. The units tendered match the currency for price, which is why price is just a number. -**Returns** true if change can succesfully be dispensed, otherwise returns false to issue a refund and cancel the product. +**Returns** true if change will successfully be dispensed, otherwise returns false to issue a refund and cancel the product. ## ChangeDispenser Class An instance of ChangeDispenser is programmed to physically know what change it has to dispense and physically how to dispense it. ChangeDispenser is a thin JavaScript layer over native code. -- libgit2 0.21.2