Skip to content
This repository was archived by the owner on Mar 25, 2025. It is now read-only.

Commit a486d26

Browse files
author
glendc
committed
update docs regarding links and getting started
1 parent d8e406e commit a486d26

File tree

6 files changed

+48
-15
lines changed

6 files changed

+48
-15
lines changed

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,17 @@ check out some of the original Tower [guides].
101101
We work exactly the same as Tower, expect in an async manner and slightly easier to use as such.
102102
But the core ideas are obviously the same, so it should never the less help you to get started.
103103

104+
Browse the examples at [`tower-async-http/examples`](https://github.com/plabayo/tower-async/tree/master/tower-async-http/examples) to see some examples
105+
on how to use `tower-async` and its sibling crates. While these are focussed on http examples,
106+
note that:
107+
108+
- `tower-async` can work for any request-response flow (akin to `tower`);
109+
- you can also use `tower-async` with http web services without making use of the `tower-async-http` crate,
110+
it only is there to provide extra middleware for http-specific purposes, but this is all optional.
111+
112+
The documentation also contains some smaller examples and of course the codebase can be read as well,
113+
together with its unit tests.
114+
104115
## Sponsorship
105116

106117
Regular and onetime sponsors alike help us to pay the development and service costs
@@ -181,8 +192,8 @@ We do not have a roadmap for Tower Async. But here are some ideas on what you ca
181192
[`tower::ServiceBuilder`]: https://docs.rs/tower/*/tower/builder/struct.ServiceBuilder.html
182193
[`tower::Layer`]: https://docs.rs/tower/*/tower/trait.Layer.html
183194
[`tower_async`]: https://docs.rs/tower-async/*/tower_async
184-
[`tower_async::Service`]: https://docs.rs/tower-async/*/tower_async/trait.Service.html
195+
[`tower_async::Service`]: https://docs.rs/tower-async-service/*/tower_async_service/trait.Service.html
185196
[`tower_async::ServiceBuilder`]: https://docs.rs/tower-async/*/tower_async/builder/struct.ServiceBuilder.html
186-
[`tower_async::Layer`]: https://docs.rs/tower-async/*/tower_async/trait.Layer.html
197+
[`tower_async::Layer`]: https://docs.rs/tower-async-layer/*/tower_async_layer/trait.Layer.html
187198

188199
[guides]: https://github.com/tower-rs/tower/tree/master/guides

tower-async-bridge/src/lib.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@
3131
//! [`tower::ServiceBuilder`]: https://docs.rs/tower/*/tower/builder/struct.ServiceBuilder.html
3232
//! [`tower::Layer`]: https://docs.rs/tower/*/tower/trait.Layer.html
3333
//! [`tower_async`]: https://docs.rs/tower-async/*/tower_async
34-
//! [`tower_async::Service`]: https://docs.rs/tower-async/*/tower_async/trait.Service.html
34+
//! [`tower_async::Service`]: https://docs.rs/tower-async-service/*/tower_async_service/trait.Service.html
3535
//! [`tower_async::ServiceBuilder`]: https://docs.rs/tower-async/*/tower_async/builder/struct.ServiceBuilder.html
36-
//! [`tower_async::Layer`]: https://docs.rs/tower-async/*/tower_async/trait.Layer.html
36+
//! [`tower_async::Layer`]: https://docs.rs/tower-async-layer/*/tower_async_layer/trait.Layer.html
3737

3838
#[cfg(feature = "into_async")]
3939
mod into_async;

tower-async-layer/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ to integrate async functions into middleware.
2525
This fork is made entirely with the needs of the author in mind,
2626
and thus might not yet contain all features you might need.
2727

28-
Come join us at discord at <https://discord.com/channels/1114459060050333696/1123537825929900113>
28+
Come join us at discord on the `#tower-async` public channel at [Discord](https://discord.gg/29EetaSYCD)
2929
or tag `@glendc` at Tokio's Tower discord instead.
3030

3131
Where suitable we'll keep in sync (manually) with Tower and if the

tower-async-service/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ to integrate async functions into middleware.
2525
This fork is made entirely with the needs of the author in mind,
2626
and thus might not yet contain all features you might need.
2727

28-
Come join us at discord at <https://discord.com/channels/1114459060050333696/1123537825929900113>
28+
Come join us at discord on the `#tower-async` public channel at [Discord](https://discord.gg/29EetaSYCD)
2929
or tag `@glendc` at Tokio's Tower discord instead.
3030

3131
Where suitable we'll keep in sync (manually) with Tower and if the

tower-async/README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ with this (Aync Trait) version (Fork).
116116

117117
## Usage
118118

119-
Tower provides an abstraction layer, and generic implementations of various
119+
Tower (Async) provides an abstraction layer, and generic implementations of various
120120
middleware. This means that the `tower-async` crate on its own does *not* provide
121121
a working implementation of a network client or server. Instead, Tower's
122122
[`Service` trait][`Service`] provides an integration point between
@@ -170,19 +170,30 @@ To get started using all of Tower's optional middleware, add this to your
170170
`Cargo.toml`:
171171

172172
```toml
173-
tower-async = { version = "0.4", features = ["full"] }
173+
tower-async = { version = "0.1", features = ["full"] }
174174
```
175175

176176
Alternatively, you can only enable some features. For example, to enable
177177
only the [`timeout`][timeouts] middleware, write:
178178

179179
```toml
180-
tower-async = { version = "0.4", features = ["timeout"] }
180+
tower-async = { version = "0.1", features = ["timeout"] }
181181
```
182182

183183
See [here][all_layers] for a complete list of all middleware provided by
184184
Tower.
185185

186+
Browse the examples at [`tower-async-http/examples`](https://github.com/plabayo/tower-async/tree/master/tower-async-http/examples) to see some examples
187+
on how to use `tower-async` and its sibling crates. While these are focussed on http examples,
188+
note that:
189+
190+
- `tower-async` can work for any request-response flow (akin to `tower`);
191+
- you can also use `tower-async` with http web services without making use of the `tower-async-http` crate,
192+
it only is there to provide extra middleware for http-specific purposes, but this is all optional.
193+
194+
The documentation also contains some smaller examples and of course the codebase can be read as well,
195+
together with its unit tests.
196+
186197
[`Service`]: https://docs.rs/tower-async/latest/tower-async/trait.Service.html
187198
[`Layer`]: https://docs.rs/tower-async/latest/tower-async/trait.Layer.html
188199
[all_layers]: https://docs.rs/tower-async/latest/tower-async/#modules
@@ -200,9 +211,9 @@ Tower.
200211
[`tower::ServiceBuilder`]: https://docs.rs/tower/*/tower/builder/struct.ServiceBuilder.html
201212
[`tower::Layer`]: https://docs.rs/tower/*/tower/trait.Layer.html
202213
[`tower_async`]: https://docs.rs/tower-async/*/tower_async
203-
[`tower_async::Service`]: https://docs.rs/tower-async/*/tower_async/trait.Service.html
214+
[`tower_async::Service`]: https://docs.rs/tower-async-service/*/tower_async_service/trait.Service.html
204215
[`tower_async::ServiceBuilder`]: https://docs.rs/tower-async/*/tower_async/builder/struct.ServiceBuilder.html
205-
[`tower_async::Layer`]: https://docs.rs/tower-async/*/tower_async/trait.Layer.html
216+
[`tower_async::Layer`]: https://docs.rs/tower-async-layer/*/tower_async_layer/trait.Layer.html
206217

207218

208219
## Supported Rust Versions

tower-async/src/lib.rs

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -158,18 +158,29 @@
158158
//! `Cargo.toml`:
159159
//!
160160
//! ```toml
161-
//! tower-async = { version = "0.4", features = ["full"] }
161+
//! tower-async = { version = "0.1", features = ["full"] }
162162
//! ```
163163
//!
164164
//! Alternatively, you can only enable some features. For example,
165165
//! to enable only the [`timeout`][timeouts] middleware, write:
166166
//!
167167
//! ```toml
168-
//! tower-async = { version = "0.4", features = ["timeout"] }
168+
//! tower-async = { version = "0.1", features = ["timeout"] }
169169
//! ```
170170
//!
171171
//! See [here][all_layers] for a complete list of all middleware provided by
172172
//! Tower.
173+
//!
174+
//! Browse the examples at [`tower-async-http/examples`](https://github.com/plabayo/tower-async/tree/master/tower-async-http/examples) to see some examples
175+
//! on how to use `tower-async` and its sibling crates. While these are focussed on http examples,
176+
//! note that:
177+
//!
178+
//! - `tower-async` can work for any request-response flow (akin to `tower`);
179+
//! - you can also use `tower-async` with http web services without making use of the `tower-async-http` crate,
180+
//! it only is there to provide extra middleware for http-specific purposes, but this is all optional.
181+
//!
182+
//! The documentation also contains some smaller examples and of course the codebase can be read as well,
183+
//! together with its unit tests.
173184
//!
174185
//! [`Service`]: https://docs.rs/tower-async/latest/tower-async/trait.Service.html
175186
//! [`Layer`]: https://docs.rs/tower-async/latest/tower-async/trait.Layer.html
@@ -188,9 +199,9 @@
188199
//! [`tower::ServiceBuilder`]: https://docs.rs/tower/*/tower/builder/struct.ServiceBuilder.html
189200
//! [`tower::Layer`]: https://docs.rs/tower/*/tower/trait.Layer.html
190201
//! [`tower_async`]: https://docs.rs/tower-async/*/tower_async
191-
//! [`tower_async::Service`]: https://docs.rs/tower-async/*/tower_async/trait.Service.html
202+
//! [`tower_async::Service`]: https://docs.rs/tower-async-service/*/tower_async_service/trait.Service.html
192203
//! [`tower_async::ServiceBuilder`]: https://docs.rs/tower-async/*/tower_async/builder/struct.ServiceBuilder.html
193-
//! [`tower_async::Layer`]: https://docs.rs/tower-async/*/tower_async/trait.Layer.html
204+
//! [`tower_async::Layer`]: https://docs.rs/tower-async-layer/*/tower_async_layer/trait.Layer.html
194205
//!
195206
//! ## Supported Rust Versions
196207
//!

0 commit comments

Comments
 (0)