diff --git a/README.md b/README.md index 1222240..ac2a894 100644 --- a/README.md +++ b/README.md @@ -17,52 +17,11 @@ Tower aims to make it as easy as possible to build robust networking clients and servers. It is protocol agnostic, but is designed around a request / response pattern. If your protocol is entirely stream based, Tower may not be a good fit. -## Project Layout - -Tower consists of a number of components, each of which live in their own sub -crates. - -* [`tower`]: The main user facing crate that provides batteries included tower services ([docs][t-docs]). - -* [`tower-service`]: The foundational traits upon which Tower is built - ([docs][ts-docs]). - -* [`tower-layer`]: The foundational trait to compose services together - ([docs][tl-docs]). - -* [`tower-balance`]: A load balancer. Load is balanced across a number of - services ([docs][tb-docs]). - -* [`tower-buffer`]: A buffering middleware. If the inner service is not ready to - handle the next request, `tower-buffer` stores the request in an internal - queue ([docs][tbuf-docs]). - -* [`tower-discover`]: Service discovery abstraction ([docs][td-docs]). - -* [`tower-filter`]: Middleware that conditionally dispatch requests to the inner - service based on a predicate ([docs][tf-docs]). - -* [`tower-limit`]: Middleware limiting the number of requests that are - processed ([docs][tlim-docs]). - -* [`tower-reconnect`]: Middleware that automatically reconnects the inner - service when it becomes degraded ([docs][tre-docs]). - -* [`tower-retry`]: Middleware that retries requests based on a given `Policy` - ([docs][tretry-docs]). - -* [`tower-test`]: Testing utilies ([docs][ttst-docs]). - -* [`tower-timeout`]: Middleware that applies a timeout to requests - ([docs][tt-docs]). - -* [`tower-util`]: Miscellaneous additional utilities for Tower - ([docs][tu-docs]). - ## Status -Currently, only [`tower-service`], the foundational trait, has been released to -crates.io. The rest of the library will be following shortly. +Currently, `tower 0.3` is released on crates. We are currently working on cleaning +up the codebase and adding more documentation. You can follow our progress in +this [issue](https://github.com/tower-rs/tower/issues/431). ## License @@ -73,30 +32,3 @@ This project is licensed under the [MIT license](LICENSE). Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Tower by you, shall be licensed as MIT, without any additional terms or conditions. - -[`tower`]: tower -[t-docs]: https://docs.rs/tower/ -[`tower-service`]: tower-service -[ts-docs]: https://docs.rs/tower-service/ -[`tower-layer`]: tower-layer -[tl-docs]: https://docs.rs/tower-layer/ -[`tower-balance`]: tower-balance -[tb-docs]: https://docs.rs/tower-balance/ -[`tower-buffer`]: tower-buffer -[tbuf-docs]: https://docs.rs/tower-buffer/ -[`tower-discover`]: tower-discover -[td-docs]: https://docs.rs/tower-discover/ -[`tower-filter`]: tower-filter -[tf-docs]: https://docs.rs/tower-filter/ -[`tower-limit`]: tower-limit -[tlim-docs]: https://docs.rs/tower-limit/ -[`tower-reconnect`]: tower-reconnect -[tre-docs]: https://docs.rs/tower-reconnect/ -[`tower-retry`]: tower-retry -[tretry-docs]: https://docs.rs/tower-retry/ -[`tower-timeout`]: tower-timeout -[tt-docs]: https://docs.rs/tower-timeout/ -[`tower-test`]: tower-test -[ttst-docs]: https://docs.rs/tower-test/ -[`tower-util`]: tower-util -[tu-docs]: https://docs.rs/tower-util/