Docs for RealtimeChannelOptions inconsistent with implementation

[Chris Ewald]

Bug report

The documentation on this repo is inconsistent the Types and implementation for RealtimeChannelOptions.

The docs indicate that no config keyword is needed for the channel method:

realtime-js/README.md

Line 117 in 63242ff

 const channel = client.channel('presence-test', { presence: { key: '' } }) 

The type defs and implementation disagree:

realtime-js/src/RealtimeChannel.ts

Lines 13 to 14 in 63242ff

 export type RealtimeChannelOptions = { 
   config: { 

and

realtime-js/src/RealtimeChannel.ts

Lines 132 to 138 in 63242ff

 this.params.config = { 
   ...{ 
     broadcast: { ack: false, self: false }, 
     presence: { key: '' }, 
   }, 
   ...params.config, 
 } 

Not sure if the docs should be updated or the code. Let me know and I can submit a PR!

[Wen Bo Xie]

@mkcode thanks for pointing this out! it was indeed an issue with the readme so i updated it.