doc: add API doc link (#576)

bytedance · Jan 18, 2024 · 63f4c07 · 63f4c07
1 parent f806331
commit 63f4c07
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 1 deletion.
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -83,4 +83,4 @@ jobs:
       #   make release
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v1
+        uses: github/codeql-action/analyze@v2
diff --git a/README.md b/README.md
@@ -14,6 +14,9 @@ A blazingly fast JSON serializing &amp; deserializing library, accelerated by JI
 - Complete APIs for JSON value manipulation
 - Fast, fast, fast!
 
+## APIs
+see [go.dev](https://pkg.go.dev/github.com/bytedance/sonic)
+
 ## Benchmarks
 For **all sizes** of json and **all scenarios** of usage, **Sonic performs best**.
 - [Medium](https://github.com/bytedance/sonic/blob/main/decoder/testdata_test.go#L19) (13KB, 300+ key, 6 layers)

diff --git a/README_ZH_CN.md b/README_ZH_CN.md
@@ -10,6 +10,9 @@
 - Linux / MacOS / Windows（需要 Go1.17 以上）
 - Amd64 架构
 
+## 接口
+详见 [go.dev](https://pkg.go.dev/github.com/bytedance/sonic)
+
 ## 特色
 
 - 运行时对象绑定，无需代码生成