From 5fc64b2330f8b7bddede17c1f3d2237cb9243737 Mon Sep 17 00:00:00 2001
From: Jelly Terra <jellyterra@proton.me>
Date: Mon, 17 Jun 2024 06:58:44 +0000
Subject: [PATCH] Update README.md for v2.1.0

---
 README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/README.md b/README.md
index 33dc7b1..6afa614 100644
--- a/README.md
+++ b/README.md
@@ -59,10 +59,14 @@ $ cd ~/web/my_site
 $ pagine --serve :12450
 ```
 
+It automatically executes generation when file changes are detected by `inotify`.
+
 > [!NOTE]
 > Incremental generation is not implemented yet.<br/>
 > Set the `--public` under `/tmp` is recommended to reduce hard disk writes.
 
+Since v2.1.0, the server provides a WebSocket interface at `/ws` to provide event monitoring for the client, such as page updates.
+
 ## Structure
 
 ### Template
@@ -180,6 +184,10 @@ define   = { title = "Page not found" }
 | `unitBase`     | Unit's level's base dir path.                   |
 | `templateBase` | It tells the template where it has been stored. | 
 
+| Func          | Description                                           |
+|---------------|-------------------------------------------------------|
+| `getMetadata` | It returns the root node of metadata of the template. |
+
 ### Data processing
 
 | Func         | Args                        | Result |