doc: document PCSCLite::close, CardReader::close

- Update example accordingly.
santigimeno · Sep 26, 2014 · d7dfb80 · d7dfb80
1 parent c560273
commit d7dfb80
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -67,6 +67,8 @@ pcsc.on('reader', function(reader) {
                                 console.log(err);
                             } else {
                                 console.log('Data received', data);
+                                reader.close();
+                                pcsclite.close();
                             }
                         });
                     }
@@ -101,6 +103,10 @@ The PCSCLite object is an EventEmitter that notifies the existence of Card Reade
 
 Emitted whenever a new card reader is detected.
 
+#### pcsclite.close()
+
+It frees the resources associated with this PCSCLite instance. At a low level it calls [`SCardCancel`](http://pcsclite.alioth.debian.org/pcsc-lite/node21.html) so it stops watching for new readers.
+
 
 ### Class: CardReader
 
@@ -162,3 +168,7 @@ Wrapper around [`SCardTransmit`](http://pcsclite.alioth.debian.org/pcsc-lite/nod
     * *output* `Buffer`
 
 Wrapper around [`SCardControl`](http://pcsclite.alioth.debian.org/pcsc-lite/node18.html). Sends a command directly to the IFD Handler (reader driver) to be processed by the reader.
+
+#### reader.close()
+
+It frees the resources associated with this CardReader instance. At a low level it calls [`SCardCancel`](http://pcsclite.alioth.debian.org/pcsc-lite/node21.html) so it stops watching for the reader status changes.
diff --git a/examples/example.js b/examples/example.js
@@ -37,6 +37,8 @@ pcsc.on('reader', function(reader) {
                                 console.log(err);
                             } else {
                                 console.log('Data received', data);
+                                reader.close();
+                                pcsc.close();
                             }
                         });
                     }