Skip to content

Commit 0e27aad

Browse files
committed
chore(readme): new readme and add chinese readme
1 parent 18d18a5 commit 0e27aad

File tree

2 files changed

+95
-2
lines changed

2 files changed

+95
-2
lines changed

README.md

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
11
# go-hypixel-api
22

3+
---
4+
5+
## SDK Docs
6+
- [go-hypixel-api-docs](https://sn0wo2.github.io/go-hypixel-api-docs/)
7+
8+
---
9+
10+
### README Language
11+
12+
-> English
13+
[简体中文](README.zh-CN.md)
14+
15+
---
16+
317
[![ci](https://github.com/Sn0wo2/go-hypixel-api/actions/workflows/ci.yml/badge.svg)](https://github.com/Sn0wo2/go-hypixel-api/actions/workflows/ci.yml)
418
[![lint](https://github.com/Sn0wo2/go-hypixel-api/actions/workflows/lint.yml/badge.svg)](https://github.com/Sn0wo2/go-hypixel-api/actions/workflows/lint.yml)
519
[![CodeQL Advanced](https://github.com/Sn0wo2/go-hypixel-api/actions/workflows/codeql.yml/badge.svg)](https://github.com/Sn0wo2/go-hypixel-api/actions/workflows/codeql.yml)
@@ -8,7 +22,29 @@
822
[![GitHub release](https://img.shields.io/github/v/release/Sn0wo2/go-hypixel-api?color=blue)](https://github.com/Sn0wo2/go-hypixel-api/releases)
923
[![License](https://img.shields.io/badge/license-GPL3.0-green.svg)](LICENSE)
1024

11-
Hypixel API wrapper in Golang
25+
Hypixel API SDK in Golang
26+
27+
---
28+
29+
## Simple and Fast
30+
- The go-hypixel-api is designed to be as minimal and efficient as possible for rapid development. All Hypixel API endpoints are built-in and wrapped as functions.
31+
32+
## Minimal Footprint
33+
- From the beginning, go-hypixel-api was designed to minimize package size and dependencies while still being fully featured.
34+
35+
## API Rate Limit Support
36+
- It automatically handles blocking and calculates the remaining request quota based on Hypixel API response headers—no manual setup required.
37+
38+
## Flexibility
39+
- We aim to provide developers with greater flexibility. Nearly all settings in go-hypixel-api can be customized, and low-level functions are exposed.
40+
41+
## Cache Strategy Support
42+
- Although go-hypixel-api doesn't include a built-in caching module, it offers a comprehensive Hook and Callback mechanism, allowing developers to implement their own caching strategies.
43+
44+
## Rapid Adaptation
45+
- We aim to keep up with changes in the Hypixel API quickly. Thanks to its flexible core design, developers can also adapt easily when project updates lag behind.
46+
47+
---
1248

1349
📕 [Hypixel API](https://api.hypixel.net)
1450

@@ -18,4 +54,4 @@ Hypixel API wrapper in Golang
1854

1955
[GPL-3.0](LICENSE)
2056

21-
* go-hypixel-api is not affiliated or endorsed by [Hypixel](https://www.hypixel.net)
57+
* go-hypixel-api is not affiliated or endorsed by [Hypixel Inc](https://www.hypixel.net)

README.zh-CN.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# go-hypixel-api
2+
3+
---
4+
5+
## SDK 文档
6+
- [go-hypixel-api-docs](https://sn0wo2.github.io/go-hypixel-api-docs/)
7+
8+
---
9+
10+
### README 语言
11+
12+
[English](README.md)
13+
-> 简体中文
14+
15+
---
16+
17+
[![ci](https://github.com/Sn0wo2/go-hypixel-api/actions/workflows/ci.yml/badge.svg)](https://github.com/Sn0wo2/go-hypixel-api/actions/workflows/ci.yml)
18+
[![lint](https://github.com/Sn0wo2/go-hypixel-api/actions/workflows/lint.yml/badge.svg)](https://github.com/Sn0wo2/go-hypixel-api/actions/workflows/lint.yml)
19+
[![CodeQL Advanced](https://github.com/Sn0wo2/go-hypixel-api/actions/workflows/codeql.yml/badge.svg)](https://github.com/Sn0wo2/go-hypixel-api/actions/workflows/codeql.yml)
20+
[![Dependabot Updates](https://github.com/Sn0wo2/go-hypixel-api/actions/workflows/dependabot/dependabot-updates/badge.svg)](https://github.com/Sn0wo2/go-hypixel-api/actions/workflows/dependabot/dependabot-updates)
21+
[![Go Report Card](https://goreportcard.com/badge/github.com/Sn0wo2/go-hypixel-api)](https://goreportcard.com/report/github.com/Sn0wo2/go-hypixel-api)
22+
[![GitHub release](https://img.shields.io/github/v/release/Sn0wo2/go-hypixel-api?color=blue)](https://github.com/Sn0wo2/go-hypixel-api/releases)
23+
[![License](https://img.shields.io/badge/license-GPL3.0-green.svg)](LICENSE)
24+
25+
Golang 编写的 Hypixel API SDK
26+
27+
---
28+
29+
## 简单快捷
30+
- go-hypixel-api 的 API 做到了尽可能简洁, 快速的高效进行开发, 内置了所有 Hypixel API 调用路径并封装成函数
31+
32+
## 最小化
33+
- go-hypixel-api 在设计之初就希望在功能齐全情况下尽可能减小包尺寸和依赖
34+
35+
## 支持API速率限制
36+
- 通过一系列 Hypixel API 返回请求头自动计算剩余请求次数并自动进行堵塞, 无需手动设置
37+
38+
## 自由度
39+
- 我们希望给开发者提供更高的自由度, 使得 go-hypixel-api 的所有设置几乎都可以自主调节, 并暴露底层函数
40+
41+
## 缓存策略支持
42+
- 尽管 go-hypixel-api 并不考虑内置缓存模块, 但是我们提供了较为完善的 Hook 和 Callback 机制, 允许开发者通过自己的缓存策略进行存储
43+
44+
## 快速适配
45+
- 我们会尽快跟进 Hypixel API 的变化, 并在底层实现充足的自由度, 使得开发者在项目未跟进时也能快速进行适配
46+
47+
---
48+
49+
📕 [Hypixel API](https://api.hypixel.net)
50+
51+
⚠️ [Hypixel API 政策](https://developer.hypixel.net/policies)
52+
53+
## 许可证
54+
55+
[GPL-3.0](LICENSE)
56+
57+
* go-hypixel-api 不隶属于 [Hypixel Inc](https://www.hypixel.net) 也未被 [Hypixel Inc](https://www.hypixel.net) 所认可

0 commit comments

Comments
 (0)