Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
juhaku committed Jan 18, 2022
1 parent 962a9f3 commit 5f64113
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Utoipa crate provides autogenerated OpenAPI documentation for Rust REST APIs. It
first class citizen and simplifies API documentation by providing simple macros for generating the
documentation from your code.

It also contains Rust types of OpenAPI spec allowing you to write the OpenAPI speck only using Rust as well if
It also contains Rust types of OpenAPI spec allowing you to write the OpenAPI spec only using Rust if
autogeneration is not your flavor or does not fit your purpose.

In future there are plans to support more sophisticated code generation from generated OpenAPI spec and as well
Expand Down Expand Up @@ -154,8 +154,9 @@ This would produce api doc something similar to:

## Goals

Eeasy of use, and easy of development along with excessive cloning keeping perfomance in mind while developing
the library. It should follow the general rust quidelines and latest conventions of the Rust.
Eeasy of use, and easy of development along with avoinding excessive cloning and keeping perfomance in
mind while developing the library. It should follow the general rust quidelines and latest conventions
of the Rust.

Goal|Status
-|-
Expand All @@ -168,7 +169,8 @@ Integration with Rocker framework | :x: Not done
Write exessive documentation & Book & Examples | :x: Not done
At least 90 % tested code | :heavy_minus_sign: Still ongoing along with the other development

Integration with other frameworks are not planned as of this stage but when the intial set of features are complete the integrations with other frameworks can be prioritized.
Integration with other frameworks are not planned as of this stage but when the intial set of features are
complete the integrations with other frameworks can be prioritized.

# License

Expand Down

0 comments on commit 5f64113

Please sign in to comment.