From 8ae1307a1738e866a9f3fbce28c910c988e99b91 Mon Sep 17 00:00:00 2001
From: Rik Berkelder <mail@riksolo.com>
Date: Fri, 29 Jan 2021 22:45:01 +0100
Subject: [PATCH] update docs & readme

---
 README.md        | 12 +++++-------
 src/oscClient.ts |  7 +++----
 src/oscServer.ts | 11 +++++++++--
 3 files changed, 17 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 9a1c36b..a7bdec2 100644
--- a/README.md
+++ b/README.md
@@ -5,17 +5,15 @@ API Docs [here](https://riksolo.pages.riksolo.com/ts-osc/)
 
 ## Usage example
 ```javascript
-import {OSCClient, OSCType} from 'ts-osc';
+import {OSCClient, OSCType, OSCServer} from 'ts-osc';
 
-const client = new OSCClient({
-    outHost: "localhost",
-    outPort: 8000,
-    inPort: 8000
-})
+const client = new OSCClient("localhost", 8000);
 
 client.send('/hello', OSCType.String, "hello");
 
-client.on('message', (msg)=>{
+const server = new OSCServer("0.0.0.0", 8000);
+
+server.on('message', (msg)=>{
     console.log(msg);
 })
 ```
diff --git a/src/oscClient.ts b/src/oscClient.ts
index b585737..0adc201 100644
--- a/src/oscClient.ts
+++ b/src/oscClient.ts
@@ -1,13 +1,12 @@
 import * as dgram from 'dgram';
 import { toBuffer } from 'osc-min';
 import { OSCArgument, OSCType, OSCArgumentType } from './types';
-import { EventEmitter } from 'events';
 
 /**
- * OSC Client base class, handles sending and receiving OSC messages
+ * OSC Client, handles sending OSC messages
 
    ```
-   const osc = new OSCClient("192.168.0.44", 8000)
+   const osc = new OSCClient("192.168.0.44", 8000);
    ```
  */
 export class OSCClient {
@@ -27,7 +26,7 @@ export class OSCClient {
   /**
    * Send an OSC message
      ```
-     osc.send("/osc/url", OSCType.String, "hello")
+     osc.send("/osc/url", OSCType.String, "hello");
      ```
    */
 
diff --git a/src/oscServer.ts b/src/oscServer.ts
index 36b892a..84e6c2b 100644
--- a/src/oscServer.ts
+++ b/src/oscServer.ts
@@ -24,14 +24,21 @@ export declare interface OSCServer {
   on(event: 'listening', listener: () => void): this;
 }
 
+/**
+ * OSC Client, handles sending OSC messages
+
+   ```
+   const osc = new OSCServer("192.168.0.44", 8000);
+   ```
+ */
 export class OSCServer extends EventEmitter {
   private socket: dgram.Socket;
 
-  constructor(address: string, port: number) {
+  constructor(bindAddress: string, port: number) {
     super();
 
     this.socket = dgram.createSocket({ type: 'udp4', reuseAddr: true });
-    this.socket.bind(port, address);
+    this.socket.bind(port, bindAddress);
 
     this.socket.on('listening', () => {
       this.emit('listening');