Merge pull request #16 from yassun4dev/update_readme

Update: README.

Author: ya7010

README.md

@@ -34,6 +34,13 @@ let s = SampleEnum::Named {
 assert!(s.validate().is_ok());
 ```
 
+## Feature Flags
+
+- `toml` - provide serialization/deserialization in `toml` format.
+- `yaml` - provide serialization/deserialization in `yaml` format.
+- `i128` - support `i128`/`u128` type.
+- `flatten` - change formatting to flattened error messages ( [jsonschema](https://docs.rs/jsonschema/latest/jsonschema/) crate style).
+
 ## Validations
 
 Serde Valid support standard validation based JSON Schema.
@@ -257,7 +264,9 @@ assert!(s.validate().is_ok());
 ```
 
 ## Validation Errors Format
+
 ### Named Struct
+
 Field errors are output to `properties`.
 
 ```rust
@@ -287,6 +296,7 @@ assert_eq!(
 ```
 
 ### Unnamed Struct
+
 Field errors are output to `items`. The key for `items` is guaranteed to be a string of positive numbers.
 
 ```rust
@@ -319,6 +329,7 @@ assert_eq!(
 ```
 
 ### New Type
+
 Field errors are output to `errors`.
 
 ```rust
@@ -342,6 +353,7 @@ assert_eq!(
 ```
 
 ### Named Enum
+
 Variant errors are output to `properties`.
 
 ```rust
@@ -378,6 +390,7 @@ assert_eq!(
 ```
 
 ### Unnamed Enum
+
 Variant errors are output to `items`. The key for `items` is guaranteed to be a string of positive numbers.
 
 ```rust
@@ -412,6 +425,7 @@ assert_eq!(
 ```
 
 ### Newtype Enum
+
 Variant errors are output to `errors`.
 
 ```rust

axum_serde_valid/README.md

@@ -23,7 +23,7 @@ schemars  = "0.8"
 
 ### Feature Flags
 
-- `jsonschema` - provides [jsonschema](https://github.com/Stranger6667/jsonschema-rs) validation.
+- `jsonschema` - provide [jsonschema](https://github.com/Stranger6667/jsonschema-rs) validation.
 - `aide` - support [aide](https://github.com/tamasfe/aide).
 
 ### Example

axum_serde_valid/src/json.rs

@@ -1,7 +1,7 @@
 #![cfg_attr(docsrs, feature(doc_auto_cfg))]
 //! A simple crate provides a drop-in replacement for [`axum::Json`]
-//! that uses [`jsonschema`] to validate requests schemas
-//! generated via [`schemars`].
+//! that uses [jsonschema](https://docs.rs/jsonschema/latest/jsonschema/) to validate requests schemas
+//! generated via [schemars](https://docs.rs/schemars/latest/schemars/).
 //!
 //! You might want to do this in order to provide a better
 //! experience for your clients and not leak serde's error messages.

axum_serde_valid/src/query.rs

@@ -1,7 +1,7 @@
 #![cfg_attr(docsrs, feature(doc_auto_cfg))]
 //! A simple crate provides a drop-in replacement for [`axum::extract::Query`]
-//! that uses [`jsonschema`] to validate requests schemas
-//! generated via [`schemars`].
+//! that uses [jsonschema](https://docs.rs/jsonschema/latest/jsonschema/) to validate requests schemas
+//! generated via [schemars](https://docs.rs/schemars/latest/schemars/).
 //!
 //! You might want to do this in order to provide a better
 //! experience for your clients and not leak serde's error messages.

axum_serde_valid/src/rejection.rs

@@ -4,7 +4,7 @@ use serde_valid::flatten::IntoFlat;
 
 use crate::json_pointer::JsonPointer;
 
-/// Rejection for [`Json`].
+/// Rejection for [`axum::Json`].
 #[derive(Debug)]
 pub enum Rejection {
     /// A rejection returned by [`axum::Json`].

serde_valid/README.md

@@ -34,6 +34,13 @@ let s = SampleEnum::Named {
 assert!(s.validate().is_ok());
 ```
 
+## Feature Flags
+
+- `toml` - provide serialization/deserialization in `toml` format.
+- `yaml` - provide serialization/deserialization in `yaml` format.
+- `i128` - support `i128`/`u128` type.
+- `flatten` - change formatting to flattened error messages ( [jsonschema](https://docs.rs/jsonschema/latest/jsonschema/) crate style).
+
 ## Validations
 
 Serde Valid support standard validation based JSON Schema.

serde_valid/src/lib.rs

@@ -34,15 +34,20 @@
 //! assert!(s.validate().is_ok());
 //! ```
 //!
+//! ## Feature Flags
+//!
+//! - `toml` - provide serialization/deserialization in `toml` format.
+//! - `yaml` - provide serialization/deserialization in `yaml` format.
+//! - `i128` - support `i128`/`u128` type.
+//! - `flatten` - change formatting to flattened error messages ( [jsonschema](https://docs.rs/jsonschema/latest/jsonschema/) crate style).
+//!
 //! ## Validations
 //!
 //! Serde Valid support standard validation based JSON Schema.
 //!
 //! | Type | Serde Valid(validate derive) | Serde Valid(validate trait) | Json Schema |
-//! | :-----: | :----------------------------------- |
-//! :----------------------------------------------------- |
-//! :-----------------------------------------------------------------------------------------------------
-//! | | String  | `#[validate(max_length = 5)]`        | [`ValidateMaxLength`](ValidateMaxLength)               | [maxLength](https://json-schema.org/understanding-json-schema/reference/string.html#length)            |
+//! | :-----: | :----------------------------------- | :----------------------------------------------------- | :----------------------------------------------------------------------------------------------------- |
+//! | String  | `#[validate(max_length = 5)]`        | [`ValidateMaxLength`](ValidateMaxLength)               | [maxLength](https://json-schema.org/understanding-json-schema/reference/string.html#length)            |
 //! | String  | `#[validate(min_length = 5)]`        | [`ValidateMinLength`](ValidateMinLength)               | [minLength](https://json-schema.org/understanding-json-schema/reference/string.html#length)            |
 //! | String  | `#[validate(pattern = r"^\d{5}$")]`  | [`ValidatePattern`](ValidatePattern)                   | [pattern](https://json-schema.org/understanding-json-schema/reference/string.html#regular-expressions) |
 //! | Numeric | `#[validate(maximum = 5)]`           | [`ValidateMaximum`](ValidateMaximum)                   | [maximum](https://json-schema.org/understanding-json-schema/reference/numeric.html#range)              |