From cb3e9a16b96afa4632bfc9d2fd219338a873a446 Mon Sep 17 00:00:00 2001 From: skiffer-git <72860476+skiffer-git@users.noreply.github.com> Date: Wed, 22 Sep 2021 17:44:38 +0800 Subject: [PATCH] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a36b3262e..48913e37e 100644 --- a/README.md +++ b/README.md @@ -162,6 +162,7 @@ All images are available at https://hub.docker.com/r/lyt1123/open_im_server - **Parameter** + | parameter name | required | Type | Description | | -------------- | -------- | ------ | ------------------------------------------------------------ | | secret | Y | string | The secret key used by the app server to connect to the sdk server. The maximum length is 32 characters. It must be ensured that the secret keys of the app server and the sdk server are the same. There is a risk of secret leakage, and it is best to save it on the user server. | @@ -174,6 +175,7 @@ All images are available at https://hub.docker.com/r/lyt1123/open_im_server | birth | N | string | The birthday of the user, the maximum length is 16 characters, can be set as an empty string | | email | N | string | User email, the maximum length is 64 characters, can be set as an empty string | | ex | N | string | User business card extension field, the maximum length is 1024 characters, users can extend it by themselves, it is recommended to encapsulate it into a JSON string, or set it to an empty string | + - **Return Parameter** @@ -244,4 +246,4 @@ All images are available at https://hub.docker.com/r/lyt1123/open_im_server ## License -Open-IM-Server is under the Apache 2.0 license. See the [LICENSE](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/LICENSE) file for details. \ No newline at end of file +Open-IM-Server is under the Apache 2.0 license. See the [LICENSE](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/LICENSE) file for details.