feat: updated readme and examples

Author: bregydoc

README.md

@@ -2,18 +2,34 @@
 
 `auto-rust` is an experimental project that aims to automatically generate Rust code with LLM (Large Language Models) during compilation, utilizing procedural macros.
 
+## ⚠️ Warning
+
+Please note that Auto-Rust is currently under development and is not yet suitable for production use. While you are welcome to try it out and provide feedback, we caution that it may have an incomplete implementation and may not function as intended.
+
+## Installation
+
+```toml
+[dependencies]
+auto-rust = "0.1.0"
+```
+
 ## Example
 
 ```rust
-use auto_rust::implement;
+use auto_rust::auto_implement;
 
-implement!(fn is_email(input: Into<String>) -> bool);
+#[auto_implement]
+#[doc = "This function calculates if the input is a valid email address without use regex."]
+fn is_email(input: String) -> bool {
+    todo!()
+}
 
 fn main() {
-    let result = is_email("hello@minsky.cc");
-    assert_eq!(result, true);
-
-    let result = is_email("hello@minsky");
-    assert_eq!(result, false);
+    let result = is_email("bregyminsky.cc".to_string());
+    println!("result: {}", result);
 }
 ```
+
+## Contributing
+
+Contributions are welcome. Feel free to open an issue if you have any questions or want to suggest an improvement.

examples/pi.rs

@@ -2,12 +2,12 @@ use auto_rust::auto_implement;
 
 #[auto_implement]
 /// This function calculates pi with a reliable algorithm.
-fn calculate_pi_with_n_decimals(n: u32) -> f64 {
+fn calculate_pi_with_n_iterations(n: u32) -> f64 {
     todo!()
 }
 
 fn main() {
-    let result = calculate_pi_with_n_decimals(100);
+    let result = calculate_pi_with_n_iterations(100);
     println!("pi: {}", result);
     // assert_eq!(result, 3.0418396189294032);
 }

examples/simple.rs

@@ -1,6 +1,9 @@
-use auto_rust::implement;
+use auto_rust::auto_implement;
 
-implement!(fn my_ip() -> String);
+#[auto_implement]
+fn my_ip() -> String {
+    todo!()
+}
 
 fn main() {
     let result = my_ip();