From 2296f5147bbf7b86eebf51d33086fbcd00158c67 Mon Sep 17 00:00:00 2001
From: hans <hense@tinysoft.com.cn>
Date: Tue, 8 Feb 2022 16:32:09 +0800
Subject: [PATCH] readme

---
 README.md | 78 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 78 insertions(+)
 create mode 100755 README.md

diff --git a/README.md b/README.md
new file mode 100755
index 0000000..8852ca5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,78 @@
+# FsSync天软文件夹同步工具V1.0
+
+  采用C-S架构，服务端监控NTFS文件系统USN文件记录表（与everything同样的技术），
+能秒级侦测到指定文件夹文件变动。特别适用与有大量子文件夹、文件的应用场景（如几十万、甚至上千万个文件）。
+与传统文件夹扫描技术相比，完全没有文件夹扫描开销。
+
+```
+server: 
+   运行环境: windows + Microsoft Visual C++ Redistributable 2019
+   参考下载地址: https://download.visualstudio.microsoft.com/download/pr/9e04d214-5a9d-4515-9960-3d71398d98c3/1e1e62ab57bbb4bf5199e8ce88f040be/vc_redist.x64.exe
+   配置文件: fs-svr.ini(支持多个目录)，用户token信息存储在: .\user\taskname-userid文件中
+[TASK-1]
+NAME=task-name-1
+PATH=d:\data\task-path-1
+EXCLUDE=log;log2
+timeout=10000
+   
+client（不依赖其它库环境）: 
+   windows环境: FSClient-win-x64-v1.0.exe
+   linux-arm64: fsclient-aarch64-v1.0
+   linux-x64:   fsclient-x64-v1.0
+   
+client使用说明:   
+   fs-client.conf(josn串)配置文件: 
+{
+  "ip":"xxxx:port",
+  "name":"path-name",
+  "taskcnt":16,
+  "zip":1,
+  "dsize":512000,
+  "path":"/data/mypath",
+  "uid":"user-id",
+  "token":"1234-7890-abcd-8901",
+  "del":true,
+  "log":true
+}
+
+  可以使用命令行参数输入，或配置文件输入: 
+  Usage of fsclient-x64-v1.0
+  -L    [-L] log to file.
+  -alsologtostderr
+        log to standard error as well as files
+  -c string
+        [-c] fs-client.conf Use the profile parameters if the profile exists.
+  -d string
+        [-d] The directory to store the downloaded file.
+  -h string
+        [-h] ip:port.
+  -log_backtrace_at value
+        when logging hits line file:N, emit a stack trace
+  -log_dir string
+        If non-empty, write log files in this directory
+  -logtostderr
+        log to standard error instead of files
+  -n string
+        [-n] SyncName.
+  -p int
+        [-p] capacity. (default 2048000)
+  -r    [-r] delete no exists file.
+  -stderrthreshold value
+        logs at or above this threshold go to stderr
+  -t string
+        [-t] token.
+  -u string
+        [-u] uid.
+  -v value
+        log level for V logs
+  -vmodule value
+        comma-separated list of pattern=N settings for file-filtered logging
+  -x int
+        [-x] Download a file using N connections (default 1)
+  -z int
+        [-z] compress. (default 1)
+
+Demo:
+    fsclient-x64-v1.0 -c /data/mypath/fs-client.conf
+    fsclient-x64-v1.0 -alsologtostderr -d /data/mypath -h x.x.x.x:port -log_dir /data/mypath/.download~~~/log -n path-name -p 512000 -r -L -t 1234-7890-abcd-8901 -x 16 -z 1
+```      
\ No newline at end of file