add LICENSE

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022-now Flashcat Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,22 +1,31 @@
-# categraf
+# Categraf
 
-monitoring agent
+Categraf is a monitoring agent for nightingale.
 
-## build
+## Build
 
 ```shell
-export GO111MODULE=on
+# export GO111MODULE=on
-export GOPROXY=https://goproxy.cn
+# export GOPROXY=https://goproxy.cn
 go build
 ```
 
-## pack
+## Test
+
+```shell
+./categraf --test
+
+# usage:
+./categraf --help
+```
+
+## Pack
 
 ```shell
 tar zcvf categraf.tar.gz categraf conf
 ```
 
-## todo
+## TODO
 
 - [ ] k8s solution
 - [ ] nginx vts
@@ -42,3 +51,7 @@ tar zcvf categraf.tar.gz categraf conf
 - [ ] logging
 - [ ] trace
 - [ ] io.util
+
+## Thanks
+
+Categraf is developed on the basis of Telegraf and Exporters. Thanks to the great open source community.