Readme documentation drift

[paralin]

Hi,

It appears the readme is out of date - it's written as if MplexStreamMuxer was exported as Muxer, but instead there's the new factory approach in place.

Am I correct on this?

[achingbrain]

I don't know how useful the API docs in this repo are - it's an implementation of interface-stream-muxer so really only the deviations from that API should be documented otherwise it's redundant and liable to get out of date.

Would you like to open a PR to improve the docs?

[paralin]

I've not got the time to do that this week but if it remains unsolved long enough I can take a look.

As far as I can tell the interface docs are also wrong - they say "import Muxer from your-muxer-pkg; new Mixer()" which doesn't work, needs the Factory pattern.

[BigLep]

@paralin : core maintainers are not going to get to this work anytime soon. We'll certainly review if you make a PR though. Any help is welcome. Thanks.

[github-actions]

Oops, seems like we needed more information for this issue, please comment with more details or this issue will be closed in 7 days.

[paralin]

Commenting to keep the issue open.