Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve docs and examples #1355

Merged
merged 1 commit into from
Apr 8, 2018
Merged

Improve docs and examples #1355

merged 1 commit into from
Apr 8, 2018

Conversation

lpinca
Copy link
Member

@lpinca lpinca commented Apr 7, 2018

  • Improve documentation for the port, server, and noServer options.
  • Remove Express example in favour of a general external server integration example.
  • Add "noServer" mode example.

@lpinca
Copy link
Member Author

lpinca commented Apr 7, 2018

cc: @rgranger @kmathmann

@rgranger
Copy link

rgranger commented Apr 7, 2018

Very nice ! Maybe add that the option { port } will automatically start the internal httpServer (unlike the option server and noServer that waits for the use to call .listen(port).

Or maybe add the functions .listen(port) and .close() to the WebsocketServer ? That would allow the user to close and open the server without having to create a new instance.

@lpinca
Copy link
Member Author

lpinca commented Apr 7, 2018

Updated.

@lpinca lpinca merged commit c801e99 into master Apr 8, 2018
@lpinca lpinca deleted the improve/docs branch April 8, 2018 19:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants