Update README and comments #281
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## 2.x.x #281 +/- ##
==========================================
- Coverage 85.12% 85.07% -0.06%
==========================================
Files 78 78
Lines 4566 4550 -16
==========================================
- Hits 3887 3871 -16
Misses 679 679 ☔ View full report in Codecov by Sentry. |
Joannis
requested changes
Nov 19, 2023
README.md
Outdated
|
|
||
| ## HummingbirdCore | ||
|
|
||
| HummingbirdCore contains a Swift NIO based HTTP server. You will find the code for it in the [hummingbird-core](https://github.com/hummingbird-project/hummingbird-core) repository. The HTTP server is initialized with a object conforming to protocol `HBHTTPResponder` which defines how your server responds to an HTTP request. The HTTP server can be extended to support TLS and HTTP2 via the `HummingbirdTLS` and `HummingbirdHTTP2` libraries also available in the hummingbird-core repository. | ||
| HummingbirdCore contains a Swift NIO based server framework. The server framework `HBServer` can be used to support many protocols but is primarily designed to support HTTP. By default it is setup to be an HTTP/1.1 server, but it can support TLS and HTTP2 via the `HummingbirdTLS` and `HummingbirdHTTP2` libraries. |
There was a problem hiding this comment.
..., but it can support TLS and HTTP2 via the
HummingbirdTLSandHummingbirdHTTP2libraries.
Wouldn'tmodulesbe clearer? As these features are in the hummingbird package itself, this might lead people to search for packages with those names
| @@ -28,7 +28,7 @@ public enum XCTRouterTestingSetup { | |||
| case router | |||
| } | |||
|
|
|||
| /// Extends `HBApplicationBuilder` to support testing of applications | |||
| /// Extends `HBApplicationB` to support testing of applications | |||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.