From da088011c1a8ae2193eefa2f553c829b6c20d515 Mon Sep 17 00:00:00 2001
From: Jian Zeng <anonymousknight96@gmail.com>
Date: Wed, 3 Jan 2024 00:38:53 +0800
Subject: [PATCH] doc: add migration guide to README

Signed-off-by: Jian Zeng <anonymousknight96@gmail.com>
---
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/README.md b/README.md
index 8e36a01..bb57674 100644
--- a/README.md
+++ b/README.md
@@ -84,3 +84,14 @@ For more details of the configuration file, please refer to the [yukid handbook]
 
 * [yukid](./cmd/yukid/README.md): Yuki daemon
 * [yukictl](./cmd/yukictl/README.md): Yuki cli
+
+## Migration Guide
+
+### v0.3.x -> v0.4.x
+
+```bash
+sed -i.bak ’s/log_dir/repo_logs_dir/’ /etc/yuki/daemon.toml
+# Also remember to update the `images_upgrade_interval` field in /etc/yuki/daemon.toml if it is set.
+
+sed -i.bak ’s/interval/cron/‘ /path/to/repo/configs/*.yaml
+```