From bd42a6602f80e7e0f1282f4a9ffbb4a9a4a3d4d2 Mon Sep 17 00:00:00 2001
From: Aaron LI <aly@aaronly.me>
Date: Mon, 12 Mar 2018 19:56:59 +0800
Subject: README: add the usage section

---
 README | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/README b/README
index fe01472..caede80 100644
--- a/README
+++ b/README
@@ -14,6 +14,32 @@ This tool is written by the author to help keep the DragonFly BSD system
 on a low-end VPS up-to-date, without consuming too much resources to build
 and update from source, which may be even impossible for a small VPS.
 
+Usage
+-----
+dfly# git clone https://github.com/liweitianux/dfly-update
+dfly# cd dfly-update
+
+* one step update:
+  dfly# ./dfly-update fly
+
+* step-by-step update:
+  1. check local and remote status:
+     dfly# ./dfly-update status
+  2. use the above printed remote filename and md5 to download it:
+     dfly# ./dfly-update <filename> <md5>
+  3. mount the download image
+     dfly# ./dfly-update /var/tmp/dfly-update/<filename
+  4. backup the current kernel and world
+     dfly# ./dfly-update backup
+  5. install the new kernel, world, and config files
+     dfly# ./dfly-update upgrade
+  6. remove obsolete files, umount, and remove downloaded image
+     dfly# ./dfly-update cleanup
+
+NOTE:
+after this, you still need to merge the listed config files with suffix
+".__new__", and also upgrade the packages.
+
 Versions
 --------
 * 0.1.2 (2018-03-11) First usable version for broader testing
-- 
cgit v1.2.2