Add documents

Author: JalonWong

Cargo.toml

@@ -8,9 +8,10 @@
     name = "sync-code"
     readme = "README.md"
     repository = "https://github.com/mcu-rust/sync-code"
-    version = "0.1.0"
+    version = "0.1.1"
 
 [lib]
+    doc = true
     doctest = false
 
 [dependencies]

README.md

@@ -2,6 +2,8 @@
 
 Synchronize code blocks between different files.
 
+It can replace `macros` in certain scenarios. For example, when your code isn’t duplicated many times but the design is relatively complex (e.g., involving generics), using `sync-code` instead of a `macro` will give you much better readability and easier maintenance. Features like Go-to-definition and intelligent auto-completion also work properly without using `macros`.
+
 # Usage
 `Cargo.toml`:
 ```toml
@@ -20,4 +22,14 @@ fn main() {
 
 ```
 
-See also [tests](/tests)
+`your_code.rs`:
+```rust
+// $sync block_name
+
+fn code_you_want_to_sync() {
+}
+
+// $sync end
+```
+
+See also [tests](/tests/test.rs)

src/lib.rs

@@ -1,5 +1,12 @@
 //! Synchronize code blocks between different files.
 //!
+//! It can replace `macros` in certain scenarios.
+//! For example, when your code isn’t duplicated many times but the design is
+//! relatively complex (e.g., involving generics), using `sync-code` instead
+//! of a `macro` will give you much better readability and easier maintenance.
+//! Features like Go-to-definition and intelligent auto-completion also work
+//! properly without using `macros`.
+//!
 //! # Usage
 //! `Cargo.toml`:
 //! ```toml
@@ -17,6 +24,16 @@
 //! }
 //!
 //! ```
+//!
+//! `your_code.rs`:
+//! ```rust
+//! // $sync block_name
+//!
+//! fn code_you_want_to_sync() {
+//! }
+//!
+//! // $sync end
+//! ```
 
 mod sync;
 

tests/test.rs

@@ -6,6 +6,7 @@ fn test_sync_code() {
     sync_code::Builder::new()
         .add("tests/data1/target.txt", "tests/data1/source.txt")
         .add("tests/data2/target.txt", "tests/data2/source.txt")
+        // Chain dependence
         .add("tests/data3/source2.txt", "tests/data3/source.txt")
         .add("tests/data3/target.txt", "tests/data3/source2.txt")
         .sync();