Update README.md

README.md

@@ -14,10 +14,42 @@
 
 A client for an insecure HAP-NodeJS instance. Provides a Typescript based interface based on the homekit accessory protocol, allowing the creation of clients able to connect to and control Homebridge devices.
 
+# API
+
+```
+const { HapClient } = require('@homebridge/hap-client');
+
+this.hapClient = new HapClient({
+  config: { debug: true },
+  pin: config.username,
+  logger: this.log,
+});
+
+this.monitor = await this.hapClient.monitorCharacteristics(services?: ServiceType[]);  // Creates event monitors for all event capabable Homebridge services.  If a list of services is, this list is used rather than all
+```
+
+## hap-client Events
+
+```
+this.hapClient.on('instance-discovered', this.instanceDiscovered(instance: HapInstance));  // Emitted during discovery for each HB instance discovered
+
+this.hapClient.on('discovery-terminated', this.discoveryTerminated());  // Instance discovery was terminated
+
+this.hapClient.on('discovery-ended', this.discoveryEnded());  // Emitted when discovery has ended ( 60 Seconds )
+
+this.monitor.on('service-update', this.serviceUpdate(services)); // Emitted when a characteristic change is received from a homebridge service
+
+this.monitor.on('monitor-close', this.monitorClose(instance, data)); // Emitted when the connection to a homebridge service is closed ( likely a restart )
+
+this.monitor.on('monitor-error', this.monitorError(instance, data)); // Emitted when the connection to a homebridge service has an error ( likely a restart )
+```
+
+
 # Dependant Applications
 
 - homebridge-config-ui-x
 - homebridge-gsh
+- node-red-contrib-homebridge-automation
 
 - [NPM Dependants](https://www.npmjs.com/package/@homebridge/hap-client?activeTab=dependents)