Create README.md

starfork · Dec 28, 2023 · 8050a06 · 8050a06
1 parent 6fe7219
commit 8050a06
Showing 1 changed file with 27 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,27 @@
+## Description
+Watch file change and send notify to your telegram
+
+## Config Sample 
+
+```yaml
+token: "your token"
+chatid: yourchatid
+max: max length of the send
+interval: 10
+path:
+  - "path1"
+  - "path2"
+  - "path3"
+```
+
+## install
+
+```
+go install https://github.com/starfork/fwatcher@latest
+```
+
+## Usage
+```
+fwatcher 
+```
+