updated readme

Author: kerryjiang

README.md

@@ -6,16 +6,43 @@
 
 dotnet-mysql-replication is a C# Implementation of MySQL replication protocol client. This allows you to receive events like insert, update, delete with their data and raw SQL queries from MySQL.
 
-## Usage
+## Features
 
-```csharp
+- Connect to MySQL server as a replica
+- Parse and process binary log events in real-time
+- Support for all MySQL data types including JSON, BLOB, TEXT, etc.
+- Handle various events including:
+  - Query events (raw SQL statements)
+  - Table maps
+  - Row events (insert, update, delete)
+  - Format description events
+  - Rotate events
+  - XID events (transaction identifiers)
+- Checksum verification support
+- Built-in support for MySQL binary format parsing
+- Async/await first design
+
+## Requirements
+
+- .NET 6.0+ or .NET Core 3.1+
+- MySQL server with binary logging enabled
+- MySQL user with replication privileges
+
+## Installation
+
+```
+dotnet add package SciSharp.MySQL.Replication
+```
+
+## Basic Usage
 
+```csharp
 using SciSharp.MySQL.Replication;
 
 var serverHost = "localhost";
 var username = "root";
 var password = "scisharp";
-var serverId =  1; // replication server id
+var serverId = 1; // replication server id
 
 var client = new ReplicationClient();
 var result = await client.ConnectAsync(serverHost, username, password, serverId);
@@ -34,8 +61,117 @@ client.PackageHandler += (s, p) =>
 
 client.StartReceive();
 
-//...
+// Keep your application running to receive events
+// ...
 
 await client.CloseAsync();
+```
 
+## Advanced Usage
+
+### Working with Specific Events
+
+```csharp
+using SciSharp.MySQL.Replication;
+using SciSharp.MySQL.Replication.Events;
+
+var client = new ReplicationClient();
+// ... connect to MySQL
+
+client.PackageHandler += (s, e) =>
+{
+    switch (e)
+    {
+        case WriteRowsEvent writeEvent:
+            Console.WriteLine($"INSERT on table: {writeEvent.TableId}");
+            foreach (var row in writeEvent.Rows)
+            {
+                // Process inserted rows
+                foreach (var cell in row.Cells)
+                {
+                    Console.WriteLine($"  Column: {cell.ColumnIndex}, Value: {cell.Value}");
+                }
+            }
+            break;
+            
+        case UpdateRowsEvent updateEvent:
+            Console.WriteLine($"UPDATE on table: {updateEvent.TableId}");
+            foreach (var row in updateEvent.Rows)
+            {
+                // Process before/after values for updated rows
+                Console.WriteLine("  Before update:");
+                foreach (var cell in row.BeforeUpdate)
+                {
+                    Console.WriteLine($"    Column: {cell.ColumnIndex}, Value: {cell.Value}");
+                }
+                
+                Console.WriteLine("  After update:");
+                foreach (var cell in row.AfterUpdate)
+                {
+                    Console.WriteLine($"    Column: {cell.ColumnIndex}, Value: {cell.Value}");
+                }
+            }
+            break;
+            
+        case DeleteRowsEvent deleteEvent:
+            Console.WriteLine($"DELETE on table: {deleteEvent.TableId}");
+            foreach (var row in deleteEvent.Rows)
+            {
+                // Process deleted rows
+                foreach (var cell in row.Cells)
+                {
+                    Console.WriteLine($"  Column: {cell.ColumnIndex}, Value: {cell.Value}");
+                }
+            }
+            break;
+            
+        case QueryEvent queryEvent:
+            Console.WriteLine($"SQL Query: {queryEvent.Query}");
+            Console.WriteLine($"Database: {queryEvent.DatabaseName}");
+            break;
+    }
+};
+
+client.StartReceive();
 ```
+
+### Setting Up MySQL for Replication
+
+1. Enable binary logging in your MySQL server's `my.cnf` or `my.ini`:
+
+```
+[mysqld]
+server-id=1
+log-bin=mysql-bin
+binlog_format=ROW
+```
+
+2. Create a user with replication privileges:
+
+```sql
+CREATE USER 'replication_user'@'%' IDENTIFIED BY 'password';
+GRANT REPLICATION SLAVE ON *.* TO 'replication_user'@'%';
+FLUSH PRIVILEGES;
+```
+
+### Logging
+
+You can provide a logger for detailed diagnostics:
+
+```csharp
+using Microsoft.Extensions.Logging;
+
+// Create a logger factory
+var loggerFactory = LoggerFactory.Create(builder =>
+{
+    builder.AddConsole();
+    builder.AddDebug();
+});
+
+var client = new ReplicationClient();
+client.Logger = loggerFactory.CreateLogger<ReplicationClient>();
+```
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.