From 6922999039883d674d9c70d1429a586249f889ab Mon Sep 17 00:00:00 2001
From: kercylan98 <kercylan@gmail.com>
Date: Thu, 30 Nov 2023 11:14:16 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=E4=BF=AE=E6=AD=A3=20@kuchaguangjie=20?=
 =?UTF-8?q?=E5=9C=A8=20#67=20=E6=8F=90=E5=88=B0=E7=9A=84=20README.md=20?=
 =?UTF-8?q?=E6=9C=8D=E5=8A=A1=E5=99=A8=E5=AE=9A=E6=97=B6=E5=99=A8=E7=A4=BA?=
 =?UTF-8?q?=E4=BE=8B=E9=94=99=E8=AF=AF=E3=80=81=E8=A1=A5=E5=85=85=20WithTi?=
 =?UTF-8?q?cker=20=E5=87=BD=E6=95=B0=E6=B3=A8=E9=87=8A?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md         | 2 +-
 server/options.go | 2 ++
 2 files changed, 3 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 5bd76b5..40779bf 100644
--- a/README.md
+++ b/README.md
@@ -145,7 +145,7 @@ package main
 import "github.com/kercylan98/minotaur/server"
 
 func main() {
-	srv := server.New(server.NetworkWebsocket, server.WithTicker(50, false))
+	srv := server.New(server.NetworkWebsocket, server.WithTicker(50, 10, false))
 	if err := srv.Run(":9999"); err != nil {
 		panic(err)
 	}
diff --git a/server/options.go b/server/options.go
index c843b29..68a88ff 100644
--- a/server/options.go
+++ b/server/options.go
@@ -158,6 +158,8 @@ func WithWebsocketReadDeadline(t time.Duration) Option {
 }
 
 // WithTicker 通过定时器创建服务器，为服务器添加定时器功能
+//   - size：服务器定时器时间轮大小
+//   - connSize：服务器连接定时器时间轮大小
 //   - autonomy：定时器是否独立运行（独立运行的情况下不会作为服务器消息运行，会导致并发问题）
 func WithTicker(size, connSize int, autonomy bool) Option {
 	return func(srv *Server) {