Skip to content

Commit

Permalink
docs: more example link (#114)
Browse files Browse the repository at this point in the history
* Update README.md

* docs: more example link
  • Loading branch information
chaoranz758 authored Sep 12, 2023
1 parent 3f1f095 commit 6049dd8
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@ You can enter the example for information about "How to run"
- [hello:](hello) Example of launching a hertz "hello world" application
- [config:](config) Example of configuring hertz server
- [protocol:](protocol) Example of using http1, tls and other protocols of hertz
- [HTTP1](https://github.com/cloudwego/hertz-examples/tree/main/protocol/http1) Example of hertz using HTTP1 protocol
- [TLS](https://github.com/cloudwego/hertz-examples/tree/main/protocol/tls) Example of hertz using TLS protocol
- [HTTP2](https://github.com/hertz-contrib/http2/tree/main/examples) Example of hertz using HTTP2 protocol
- [HTTP3](https://github.com/hertz-contrib/http3/tree/main/examples/quic-go) Example of hertz using HTTP3 protocol
- [Websocket](https://github.com/hertz-contrib/websocket/tree/main/examples) Example of hertz using Websocket protocol
- [SSE](https://github.com/hertz-contrib/sse/tree/main/examples) Example of hertz using SSE protocol
- [middleware:](middleware) Example of using middleware of hertz
- [basicauth:](middleware/basicauth) Example of using BasicAuth middleware
- [cors:](middleware/CORS) Example of using CORS middleware
Expand All @@ -30,6 +36,19 @@ You can enter the example for information about "How to run"
- [requestid:](middleware/requestid) Example of using RequestID middleware
- [gzip:](middleware/gzip) Example of using Gzip middleware
- [loadbalance:](middleware/loadbalance) Example of using Loadbalance middleware
- [Recovery](https://www.cloudwego.io/docs/hertz/tutorials/basic-feature/middleware/recovery/) Example of using Recovery middleware
- [jwt](https://github.com/hertz-contrib/jwt/tree/main/example/basic) Example of using jwt middleware
- [i18n](https://github.com/hertz-contrib/i18n/tree/main/example) Example of using i18n middleware
- [session](https://github.com/hertz-contrib/sessions/tree/main/_example) Example of using session middleware
- [KeyAuth](https://github.com/hertz-contrib/keyauth/tree/main/example) Example of using KeyAuth middleware
- [Swagger](https://github.com/swaggo/gin-swagger/tree/master/example) Example of using Swagger middleware
- [access log](https://github.com/hertz-contrib/logger/tree/main/accesslog/example) Example of using access log middleware
- [Secure](https://github.com/hertz-contrib/secure/tree/main/example/custom) Example of using Secure middleware
- [Sentry](https://github.com/hertz-contrib/hertzsentry) Example of using Sentry middleware
- [Casbin](https://github.com/hertz-contrib/casbin/tree/main/example) Example of using Casbin middleware
- [ETag](https://github.com/hertz-contrib/etag/tree/main/example) Example of using ETag middleware
- [Cache](https://github.com/hertz-contrib/cache/tree/main/example) Example of using Cache middleware
- [Paseto](https://github.com/hertz-contrib/paseto/tree/main/example) Example of using Paseto middleware
- [binding:](binding) Example of parameter binding and validation
- [parameters:](parameter) Example of getting query, form, cookie
- [file:](file) Examples of file upload, file download, and static file services
Expand Down
19 changes: 19 additions & 0 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@
- [hello:](hello) 启动对于 hertz 来说相当于 "hello world" 的示例
- [config:](config) 配置 Hertz server 的示例
- [protocol:](protocol) 使用 http1, TLS 以及其他协议的示例
- [HTTP1](https://github.com/cloudwego/hertz-examples/tree/main/protocol/http1) hertz 使用 HTTP1 协议的示例
- [TLS](https://github.com/cloudwego/hertz-examples/tree/main/protocol/tls) hertz 使用 TLS 协议的示例
- [HTTP2](https://github.com/hertz-contrib/http2/tree/main/examples) hertz 使用 HTTP2 协议的示例
- [HTTP3](https://github.com/hertz-contrib/http3/tree/main/examples/quic-go) hertz 使用 HTTP3 协议的示例
- [Websocket](https://github.com/hertz-contrib/websocket/tree/main/examples) hertz 使用 Websocket 协议的示例
- [SSE](https://github.com/hertz-contrib/sse/tree/main/examples) hertz 使用 SSE 协议的示例
- [middleware:](middleware) 使用 hertz 中间件的示例
- [basicauth:](middleware/basicauth) 使用 BasicAuth 中间件的示例
- [cors:](middleware/CORS) 使用 CORS 中间件的示例
Expand All @@ -30,6 +36,19 @@
- [requestid:](middleware/requestid) 使用 RequestID 中间件的示例
- [gzip:](middleware/gzip) 使用 Gzip 中间件的示例
- [loadbalance:](middleware/loadbalance) 使用 Loadbalance 中间件的示例
- [Recovery](https://www.cloudwego.io/zh/docs/hertz/tutorials/basic-feature/middleware/recovery/) 使用 Recovery 中间件的示例
- [jwt](https://github.com/hertz-contrib/jwt/tree/main/example/basic) 使用 jwt 中间件的示例
- [i18n](https://github.com/hertz-contrib/i18n/tree/main/example) 使用 i18n 中间件的示例
- [session](https://github.com/hertz-contrib/sessions/tree/main/_example) 使用 session 中间件的示例
- [KeyAuth](https://github.com/hertz-contrib/keyauth/tree/main/example) 使用 KeyAuth 中间件的示例
- [Swagger](https://github.com/swaggo/gin-swagger/tree/master/example) 使用 Swagger 中间件的示例
- [access log](https://github.com/hertz-contrib/logger/tree/main/accesslog/example) 使用 access log 中间件的示例
- [Secure](https://github.com/hertz-contrib/secure/tree/main/example/custom) 使用 Secure 中间件的示例
- [Sentry](https://github.com/hertz-contrib/hertzsentry) 使用 Sentry 中间件的示例
- [Casbin](https://github.com/hertz-contrib/casbin/tree/main/example) 使用 Casbin 中间件的示例
- [ETag](https://github.com/hertz-contrib/etag/tree/main/example) 使用 ETag 中间件的示例
- [Cache](https://github.com/hertz-contrib/cache/tree/main/example) 使用 Cache 中间件的示例
- [Paseto](https://github.com/hertz-contrib/paseto/tree/main/example) 使用 Paseto 中间件的示例
- [binding:](binding) 绑定参数和验证参数的示例
- [parameters:](parameter) 获取 query, form, cookie 等类型参数的示例
- [file:](file) 关于如何上传,下载文件和搭建静态文件服务的示例
Expand Down

0 comments on commit 6049dd8

Please sign in to comment.