docs: 完善 README.md

This commit is contained in:
kercylan98
2024-02-05 12:11:11 +08:00
parent 3549fcca11
commit 40acb567a7
8 changed files with 1887 additions and 1 deletions

View File

@@ -0,0 +1,42 @@
# Expose
[![Go doc](https://img.shields.io/badge/go.dev-reference-brightgreen?logo=go&logoColor=white&style=flat)](https://pkg.go.dev/github.com/kercylan98/minotaur)
![](https://img.shields.io/badge/Email-kercylan@gmail.com-green.svg?style=flat)
暂无介绍...
## 目录导航
列出了该 `package` 下所有的函数及类型定义,可通过目录导航进行快捷跳转 ❤️
<details>
<summary>展开 / 折叠目录导航</summary>
> 类型定义
|类型|名称|描述
|:--|:--|:--
|`INTERFACE`|[Attack](#struct_Attack)|暂无描述...
|`INTERFACE`|[Login](#struct_Login)|暂无描述...
</details>
***
## 详情信息
<span id="struct_Attack"></span>
### Attack `INTERFACE`
```go
type Attack interface {
Name() string
}
```
<span id="struct_Login"></span>
### Login `INTERFACE`
```go
type Login interface {
Name() string
}
```

View File

@@ -0,0 +1,54 @@
# Attack
[![Go doc](https://img.shields.io/badge/go.dev-reference-brightgreen?logo=go&logoColor=white&style=flat)](https://pkg.go.dev/github.com/kercylan98/minotaur)
![](https://img.shields.io/badge/Email-kercylan@gmail.com-green.svg?style=flat)
暂无介绍...
## 目录导航
列出了该 `package` 下所有的函数及类型定义,可通过目录导航进行快捷跳转 ❤️
<details>
<summary>展开 / 折叠目录导航</summary>
> 类型定义
|类型|名称|描述
|:--|:--|:--
|`STRUCT`|[Service](#struct_Service)|暂无描述...
</details>
***
## 详情信息
<span id="struct_Service"></span>
### Service `STRUCT`
```go
type Service struct {
Login expose.Login
name string
}
```
<span id="struct_Service_OnInit"></span>
#### func (*Service) OnInit()
***
<span id="struct_Service_OnPreload"></span>
#### func (*Service) OnPreload()
***
<span id="struct_Service_OnMount"></span>
#### func (*Service) OnMount()
***
<span id="struct_Service_Name"></span>
#### func (*Service) Name() string
***

View File

@@ -0,0 +1,54 @@
# Login
[![Go doc](https://img.shields.io/badge/go.dev-reference-brightgreen?logo=go&logoColor=white&style=flat)](https://pkg.go.dev/github.com/kercylan98/minotaur)
![](https://img.shields.io/badge/Email-kercylan@gmail.com-green.svg?style=flat)
暂无介绍...
## 目录导航
列出了该 `package` 下所有的函数及类型定义,可通过目录导航进行快捷跳转 ❤️
<details>
<summary>展开 / 折叠目录导航</summary>
> 类型定义
|类型|名称|描述
|:--|:--|:--
|`STRUCT`|[Service](#struct_Service)|暂无描述...
</details>
***
## 详情信息
<span id="struct_Service"></span>
### Service `STRUCT`
```go
type Service struct {
Attack expose.Attack
name string
}
```
<span id="struct_Service_OnInit"></span>
#### func (*Service) OnInit()
***
<span id="struct_Service_OnPreload"></span>
#### func (*Service) OnPreload()
***
<span id="struct_Service_OnMount"></span>
#### func (*Service) OnMount()
***
<span id="struct_Service_Name"></span>
#### func (*Service) Name() string
***

View File

@@ -0,0 +1,53 @@
# Server
[![Go doc](https://img.shields.io/badge/go.dev-reference-brightgreen?logo=go&logoColor=white&style=flat)](https://pkg.go.dev/github.com/kercylan98/minotaur)
![](https://img.shields.io/badge/Email-kercylan@gmail.com-green.svg?style=flat)
暂无介绍...
## 目录导航
列出了该 `package` 下所有的函数及类型定义,可通过目录导航进行快捷跳转 ❤️
<details>
<summary>展开 / 折叠目录导航</summary>
> 类型定义
|类型|名称|描述
|:--|:--|:--
|`STRUCT`|[Service](#struct_Service)|暂无描述...
</details>
***
## 详情信息
<span id="struct_Service"></span>
### Service `STRUCT`
```go
type Service struct {
srv *server.Server
}
```
<span id="struct_Service_OnInit"></span>
#### func (*Service) OnInit()
***
<span id="struct_Service_OnPreload"></span>
#### func (*Service) OnPreload()
***
<span id="struct_Service_OnMount"></span>
#### func (*Service) OnMount()
***
<span id="struct_Service_OnBlock"></span>
#### func (*Service) OnBlock()
***