update readme

tomoikey · Oct 23, 2024 · 19cffb8 · 19cffb8
1 parent 04af6dd
commit 19cffb8
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -32,7 +32,8 @@ struct Human {
     friends: NonEmptyVec<String>,
 }
 
-fn example_1() -> anyhow::Result<()> {
+// In the 1st example, all fields satisfy the rule, causing the conversion from JSON to succeed.
+fn get_started_simple_example() -> anyhow::Result<()> {
     let json = json! {{
         "name": "john",
         "age": 20,
@@ -91,6 +92,8 @@ fn get_started_empty_vec_example() -> anyhow::Result<()> {
 }
 ```
 
+---
+
 # Compose Rules
 
 As mentioned earlier, it is possible to combine any rules as long as the target types match.

diff --git a/tests/read_me.rs b/tests/read_me.rs
@@ -19,7 +19,7 @@ struct Human {
 }
 
 #[test]
-fn example_1() -> anyhow::Result<()> {
+fn get_started_simple_example() -> anyhow::Result<()> {
     let json = json! {{
         "name": "john",
         "age": 20,