From 1c59c902a6cfe8ec1c680fe5dd4b47963a2ea51c Mon Sep 17 00:00:00 2001
From: YuKun Liu <mrxzx.info@gmail.com>
Date: Thu, 22 Sep 2022 11:05:37 -0700
Subject: [PATCH] docs: commit docs

---
 docs/src/SUMMARY.md                  |  4 ++-
 docs/src/plugin/interface/log.md     | 48 ++++++++++++++++++++++++++++
 docs/src/plugin/interface/network.md | 34 ++++++++++++++++++++
 3 files changed, 85 insertions(+), 1 deletion(-)
 create mode 100644 docs/src/plugin/interface/log.md
 create mode 100644 docs/src/plugin/interface/network.md

diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
index 18ae0f5aa..4fa8a4ef3 100644
--- a/docs/src/SUMMARY.md
+++ b/docs/src/SUMMARY.md
@@ -10,6 +10,8 @@
   - [Clean](./cmd/clean.md)
   - [Translate](./cmd/translate.md)
 - [Plugin Development](./plugin/README.md)
+  - [API.Log](./plugin/interface/log.md)
   - [API.Command](./plugin/interface/command.md)
   - [API.OS](./plugin/interface/os.md)
-  - [API.Directories](./plugin/interface/dirs.md)
\ No newline at end of file
+  - [API.Directories](./plugin/interface/dirs.md)
+  - [API.Network](./plugin/interface/network.md)
\ No newline at end of file
diff --git a/docs/src/plugin/interface/log.md b/docs/src/plugin/interface/log.md
new file mode 100644
index 000000000..fcd72595b
--- /dev/null
+++ b/docs/src/plugin/interface/log.md
@@ -0,0 +1,48 @@
+# Log Functions
+
+> You can use log function to print some useful log info
+
+### Trace(info: string)
+
+Print trace log info
+
+```lua
+local log = plugin.log
+log.trace("trace information")
+```
+
+### Debug(info: string)
+
+Print debug log info
+
+```lua
+local log = plugin.log
+log.debug("debug information")
+```
+
+### Info(info: string)
+
+Print info log info
+
+```lua
+local log = plugin.log
+log.info("info information")
+```
+
+### Warn(info: string)
+
+Print warning log info
+
+```lua
+local log = plugin.log
+log.warn("warn information")
+```
+
+### Error(info: string)
+
+Print error log info
+
+```lua
+local log = plugin.log
+log.error("error information")
+```
\ No newline at end of file
diff --git a/docs/src/plugin/interface/network.md b/docs/src/plugin/interface/network.md
new file mode 100644
index 000000000..358c9c498
--- /dev/null
+++ b/docs/src/plugin/interface/network.md
@@ -0,0 +1,34 @@
+# Network Functions
+
+> you can use Network functions to download & read some data from internet
+
+### download_file(url: string, path: string) -> boolean
+
+This function can help you download some file from url, and it will return a *boolean* value to check the download status. (true: success | false: fail)
+
+You need pass a target url and a local path (where you want to save this file)
+
+```lua
+-- this file will download to plugin temp directory
+local status = plugin.network.download_file(
+    "http://xxx.com/xxx.zip",
+    plugin.dirs.temp_dir()
+)
+if status != true then
+    log.error("Download Failed")
+end
+```
+
+### clone_repo(url: string, path: string) -> boolean
+
+This function can help you use `git clone` command (this system must have been installed git)
+
+```lua
+local status = plugin.network.clone_repo(
+    "http://github.com/mrxiaozhuox/dioxus-starter",
+    plugin.dirs.bin_dir()
+)
+if status != true then
+    log.error("Clone Failed")
+end
+```
\ No newline at end of file