Update README.md

.github/workflows/release.yml

@@ -35,7 +35,6 @@ jobs:
         - uses: katyo/publish-crates@v1
           with:
               registry-token: ${{ secrets.CARGO_REGISTRY_TOKEN }}
-              path: packages/validation/
 
         - name: Update deployment status (success)
           if: success()

Cargo.toml

@@ -3,9 +3,9 @@ name = "rocket-validation"
 version = "0.1.0"
 edition = "2021"
 license = "MIT"
-readme = "../../Readme.md"
+readme = "README.md"
 repository = "https://github.com/somehowchris/rocket-validation"
-keywords = ["rocket", "validation", "json", "query", "data", "validator"]
+keywords = ["rocket", "validation", "json", "data", "validator"]
 categories = ["web-programming"]
 rust-version = "1.56.0"
 description = "Rocket Guards to support validation using validator"

README.md

@@ -66,4 +66,5 @@ fn rocket() -> _ {
 		.mount("/", routes![validated_hello])
 		.register("/", catchers![rocket_validation::validation_catcher])
 }
-```
+```
+> Currently limited to `Json` or `FromData` validations due to inernal rocket limitations

src/lib.rs

@@ -195,7 +195,7 @@ impl<'r, D: Validate + rocket::serde::Deserialize<'r>> FromData<'r> for Validate
     }
 }
 
-///  Implementation of `Validated` for `FromRequest`
+///  Implementation of `Validated` for `FromRequest` implementing `Validate`
 //
 ///  Anything you implement `FromRequest` for as well as `Validate`
 #[rocket::async_trait]
@@ -218,9 +218,9 @@ impl<'r, D: Validate + FromRequest<'r>> FromRequest<'r> for Validated<D> {
     }
 }
 
-// TODO Fix doc
 ///  Implementation of `Validated` for `FromForm`
-///  An example with `Json`
+///
+///  An example validating a query struct
 ///  ```rust
 ///  # #[macro_use] extern crate rocket;
 ///  use rocket::serde::{json::Json, Deserialize, Serialize};