From 62ac37137ca804bb060eb2bdd9078223d1eab676 Mon Sep 17 00:00:00 2001
From: no-passwd <143941593+no-passwd@users.noreply.github.com>
Date: Sat, 25 May 2024 18:29:22 +0800
Subject: [PATCH] ADD README.md

---
 README.md | 39 ++++++++++++++++++++++++++++++++++++++-
 1 file changed, 38 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index d527f35..a7e5cbe 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,39 @@
 # lxc-toolkit
-lxc系统检测工具,概念验证
+lxc系统检测工具,概念验证。用于获取lxc宿主信息。
+
+## 使用方法
+```bash
+wget https://github.com/no-passwd/lxc-toolkit/archive/refs/heads/main.zip
+unzip lxc-toolkit-main.zip
+cd lxc-toolkit-main
+bash lxc-toolkit.sh
+```
+
+或者 
+
+```bash
+git clone https://github.com/no-passwd/lxc-toolkit.git
+cd lxc-toolkit
+bash lxc-toolkit.sh
+```
+
+### 命令参数
+
+```bash
+lxc-toolkit.sh free -> 查看宿主机free -m
+lxc-toolkit.sh fdisk -> 查看宿主机fdisk
+lxc-toolkit.sh swapon -> 查看宿主机swapon
+lxc-toolkit.sh uptime -> 查看宿主机uptime
+lxc-toolkit.sh load -> 查看宿主机load负载
+lxc-toolkit.sh top -> 查看宿主机processes统计
+lxc-toolkit.sh cpu -> 查看宿主机cpu核心
+lxc-toolkit.sh all -> 同时运行上述所有的命令
+```
+
+### 原理
+直接使用系统调用，从内核获取信息。由于lxc与宿主机是同一个内核。可以获取到宿主机信息。
+
+可以看test.c的例子。从系统调用中获取信息，而不是/proc文件系统。
+
+## License
+MIT License