Skip to content

Commit 556fe3e

Browse files
committed
docs: update usage & return
1 parent e656e08 commit 556fe3e

File tree

1 file changed

+2
-9
lines changed

1 file changed

+2
-9
lines changed

readme.md

+2-9
Original file line numberDiff line numberDiff line change
@@ -57,21 +57,14 @@ ws.close(); // graceful shutdown
5757
setTimeout(ws.reconnect, 10e3);
5858
```
5959

60-
> **Note:** You don't have to use `new` to instantiate!
61-
62-
```js
63-
const socket = require('sockette');
64-
let ws = socket('ws://localhost:3000');
65-
```
66-
6760

6861
## API
6962

7063
### Sockette(url, options)
7164

72-
Returns: `WebSocket`
65+
Returns: `Sockette`
7366

74-
Returns the underlying [`WebSocket`][MDN] directly.
67+
Returns the `Sockette` instance.
7568

7669
#### url
7770
Type: `String`

0 commit comments

Comments
 (0)