-
-
Notifications
You must be signed in to change notification settings - Fork 142
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
Documentation to recommend Server by default instead of advanced StreamingServer #284
Conversation
9b9ee57
to
b2cf2bc
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
README.md
Outdated
@@ -160,10 +200,11 @@ Check out [request](#request) for more details. | |||
|
|||
### Request | |||
|
|||
An seen above, the `StreamingServer` class is responsible for handling incoming | |||
connections and then processing each incoming HTTP request. | |||
An seen above, the [`Server`](#server) and [`StreamingServer`](#streamingserver) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
An -> As
README.md
Outdated
been received (see also [`RequestBodyBufferMiddleware`](#requestbodybuffermiddleware) | ||
for an alternative). | ||
If you're using the advanced [`StreamingServer`](#streamingserver), the | ||
request object will be procesed once the request headers have been received. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
procesed -> processed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
2 minor typos, otherwise 👍
b2cf2bc
to
2119dd5
Compare
@jsor Good catch, updated to fix minor typos |
This PR adds some documentation to recommend
Server
by default instead of the advancedStreamingServer
. I've tried to keep changes to a minimum to ease review.There's still potential for a follow-up PR to eventually improve the README structure 👍
Builds on top of #266 and #271