docs: change README

README.md

@@ -15,16 +15,33 @@ fn main() -> AnyhowResult<()> {
   let html = "<div name='htmlentity'>Hello!世界!</div>";
   let html_after_encoded = "&lt;div name='htmlentity'&gt;Hello!&#x4e16;&#x754c;!&lt;/div&gt;";
   // encode
-  let encoded_data = encode(html.as_bytes(), &EncodeType::NamedOrHex, &CharacterSet::HtmlAndNonASCII);
+  let encoded_data = encode(
+    html.as_bytes(), 
+    // encode format
+    &EncodeType::NamedOrHex,
+    // charcters need to be encoded 
+    &CharacterSet::HtmlAndNonASCII
+  );
   assert_eq!(encoded_data.to_bytes(), html_after_encoded.as_bytes());
   assert_eq!(encoded_data.to_string()?, String::from(html_after_encoded));
-  assert_eq!(encoded_data.to_chars()?, String::from(html_after_encoded).chars().collect::<Vec<char>>());
+  let char_list = String::from(html_after_encoded).chars().collect::<Vec<char>>();
+  assert_eq!(encoded_data.to_chars()?, char_list);
   // decode
   let bytes = encoded_data.into_iter().map(|(byte, _)| *byte).collect::<Vec<Byte>>();
   let decoded_data = decode(&bytes);
   assert_eq!(decoded_data.to_bytes(), html.as_bytes());
   assert_eq!(decoded_data.to_string()?, String::from(html));
-  assert_eq!(decoded_data.to_chars()?, String::from(html).chars().collect::<Vec<char>>());
+  let char_list = String::from(html).chars().collect::<Vec<char>>();
+  assert_eq!(decoded_data.to_chars()?, char_list);
+  // shortcut usage
+  assert_eq!(
+    encode(
+      html.as_bytes(), 
+      &EncodeType::NamedOrHex,
+      &CharacterSet::HtmlAndNonASCII,
+    ).to_string()?,
+    String::from(html)
+  );
   Ok(())
 }
 ```

codecov.yml

@@ -1,2 +1,3 @@
 ignore:
-  - src/main.rs
+  - src/main.rs
+  - src/data.rs