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

doc (README.md/README-zh_CN.md): Add clarification #45

Merged
merged 1 commit into from Aug 29, 2018
Merged

doc (README.md/README-zh_CN.md): Add clarification #45

merged 1 commit into from Aug 29, 2018

Conversation

ghost
Copy link

@ghost ghost commented Aug 29, 2018

  1. Due to uws isn't supported since Nodejs 10.x, so we should mention
    it by bolding the words to tell the users to avoid using uws directly
    in Nodejs 10.x or later version.

  2. Change the uws's url, because this lib is duplicated, and we have to
    refer the npm url as the replacer. The deprecated uws SHOUDN'T have
    GitHub repository (See: https://www.npmjs.com/package/uws).

Ref:socketio/engine.io#560

@codecov
Copy link

codecov bot commented Aug 29, 2018

Codecov Report

Merging #45 into master will increase coverage by 1.18%.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##           master    #45      +/-   ##
========================================
+ Coverage   98.81%   100%   +1.18%     
========================================
  Files          11     11              
  Lines         169    169              
========================================
+ Hits          167    169       +2     
+ Misses          2      0       -2
Impacted Files Coverage Δ
lib/connectionMiddlewareInit.js 100% <0%> (+8.69%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update efef713...f87889c. Read the comment docs.

1) Due to `uws` isn't supported since Nodejs 10.x, so we should mention
it by bolding the words to tell the users to avoid using `uws` directly
in Nodejs 10.x or later version.

2) Change the uws's url, because this lib is duplicated, and we have to
refer the npm url as the replacer.
@ngot ngot merged commit 7958966 into eggjs:master Aug 29, 2018
@ghost ghost deleted the UpdateDoc branch August 29, 2018 01:43
@ghost
Copy link
Author

ghost commented Aug 29, 2018

@ngot:In fact, consider old users using uws, I'm waiting for SocketIO's response. Maybe in another PR will totally fix this. So this is a temp declaration.

@ngot
Copy link
Member

ngot commented Aug 29, 2018

  • egg-socket.io@4.1.1

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.

1 participant