Skip to content
This repository was archived by the owner on Jun 21, 2020. It is now read-only.

Commit 2d11bbf

Browse files
Bastian Gruberyoshuawuyts
Bastian Gruber
authored andcommitted
Add Futures return to README (#22)
1 parent 1f30e91 commit 2d11bbf

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,10 @@
4949
## About
5050
The crate `http-service` provides the necessary types and traits to implement your own HTTP Server. It uses `hyper` for the lower level TCP abstraction.
5151

52-
You can use the workspace member [`http-service-hyper`](https://crates.io/crates/http-service-hyper) to run your HTTP Server via `http_service_hyper::serve(HTTP_SERVICE, ADDRESS);`
52+
You can use the workspace member [`http-service-hyper`](https://crates.io/crates/http-service-hyper) to run your HTTP Server.
53+
54+
1. Runs via `http_service_hyper::run(HTTP_SERVICE, ADDRESS);`
55+
2. Returns a future which can be `await`ed via `http_service_hyper::serve(HTTP_SERVICE, ADDRESS);`
5356

5457
This crate uses the latest [Futures](https://github.com/rust-lang-nursery/futures-rs) preview, and therefore needs to be run on Rust Nightly.
5558

0 commit comments

Comments
 (0)