Update README.md

Author: htdcx

README.md

@@ -1 +1,101 @@
-# code-push-server-go
+# Code-Push-Server-Go
+CodePush Server Go is a CodePush progam server,Use with [code-push-go]()
+
+## Support Version
+- mysql  >= 8.0
+- golang >= 1.21.5
+- redis  >= 5.0
+
+## Support Client Version
+- [react-native-code-push](https://github.com/microsoft/react-native-code-push) >= 7.0
+
+## Support Storage
+- Local
+- AWS S3 
+- FTP
+## Before installation, please ensure that the following procedures have been installed
+- mysql
+- golang
+- redis
+## HOW TO INSTALL code-push-server
+
+```shell
+git clone https://github.com/htdcx/code-push-server-go.git
+cd code-push-server-go
+import code-push.sql to mysql
+```
+### Configuration mysql,redis,storage
+``` shell
+cd config
+vi (app.json or app.dev.json or app.prod.json) 
+# app.json
+{
+    "mode":"dev" #run read config app.{mode}.json
+}
+# app.prod.json
+{
+    "DBUser": {
+        "Write": {
+            "UserName": "",
+            "Password": "",
+            "Host": "127.0.0.1",
+            "Port": 3306,
+            "DBname": ""
+        },
+        "MaxIdleConns": 10,
+        "MaxOpenConns": 100,
+        "ConnMaxLifetime": 1
+    },
+    "Redis": {
+        "Host": "127.0.0.1",
+        "Prot": 6379,
+        "DBIndex": 0,
+        "UserName": "",
+        "Password": ""
+    },
+    "CodePush": {
+        "FileLocal":(local,aws,ftp),
+        "Local":{
+            "SavePath":"./bundels"
+        },
+        "Aws":{
+            "Endpoint":"",
+            "Region":"",
+            "S3ForcePathStyle":true,
+            "KeyId":"",
+            "Secret":"",
+            "Bucket":""
+        },
+        "Ftp":{
+            "ServerUrl":"",
+            "UserName":"",
+            "Password":""
+        }
+    },
+    "UrlPrefix": "/api",
+    "ResourceUrl": (nginx config url or s3),
+    "Port": ":8080",
+    "TokenExpireTime": 30 (day)
+}
+
+```
+#### Build
+``` shell
+#MacOS pack GOOS:windows,darwin
+CGO_ENABLED=0 GOOS=linux  GOARCH=amd64 go build -o code-push-server-go(.exe) main.go
+
+#Windows pack
+set GOARCH=amd64
+set GOOS=linux #windows,darwin
+go build -o code-push-server-go(.exe) main.go
+
+#copy config/app.(model).json and config/app.json to run dir and run
+./code-push-server-go
+```
+#### Use [code-push-go]()
+``` shell
+./code-push-go login -u (userName) -p (password) -h (serverUrl)
+```
+
+## License
+MIT License [read](https://github.com/htdcx/code-push-server-go/blob/main/LICENSE)