Skip to content

Commit

Permalink
Remove redundancy from README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
juhaku committed Apr 8, 2022
1 parent b2803c3 commit 38d71a5
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Existing [examples](./examples) for following frameworks:

**actix-web** has support support for actix specific parsing via **actix_extras** feature.

Even if there is no example for your favourite framework `utoipa` is portable and can be used with any
Even if there is no example for your favourite framework `utoipa` can be used with any
web framework which supports decorating functions with macros similarly to **warp** and **tide** examples.

## What's up with the word play?
Expand Down
15 changes: 14 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,23 @@
//! Currently utoipa provides simple integration with actix-web framework but is not limited to the actix-web
//! framework. All functionalities are not restricted to any specific framework.
//!
//! # Choose your flavor and document your API with ice cold IPA
//!
//! Existing [examples](https://github.com/juhaku/utoipa/tree/master/examples) for following frameworks:
//!
//! * **actix-web**
//! * **warp**
//! * **tide**
//!
//! **actix-web** has support support for actix specific parsing via **actix_extras** feature.
//!
//! Even if there is no example for your favourite framework `utoipa` can be used with any
//! web framework which supports decorating functions with macros similarly to **warp** and **tide** examples.
//!
//! # What's up with the word play?
//!
//! The name comes from words `utopic` and `api` where `uto` is the first three letters of _utopic_
//! and the `ipa` is _api_ reversed.
//! and the `ipa` is _api_ reversed. Aaand... `ipa` is also awesome type of beer.
//!
//! # Features
//!
Expand Down

0 comments on commit 38d71a5

Please sign in to comment.