Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@markus621
markus621 committed Mar 10, 2024
1 parent 2520e86 commit dc6fb5c
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,15 @@ go get -u go.osspkg.com/goppy

## Plugins

| Plugin | Comment | Import |
|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **metrics** | Profiling application (pprof) and metrics collection (prometheus) with access via HTTP. | `go.osspkg.com/goppy/metrics`<br/> `metrics.WithMetrics()` |
| **http** | Out of the box multi-server launch of web servers with separate routing. Grouping of routers with connection to a group of dedicated middleware. HTTP clients pool. | `go.osspkg.com/goppy/web`<br/> `web.WithHTTP()`<br/> `web.WithHTTPClient()` |
| **websocket** | Ready-made websocket handler for server and client. Websocket server pool. | `go.osspkg.com/goppy/ws`<br/> `ws.WithWebsocketServer()`<br/> `ws.WithWebsocketClient()`<br/> `ws.WithWebsocketServerPool()` |
| **unixsocket** | Requests via unix socket. | `go.osspkg.com/goppy/unix`<br/> `unix.WithServer()`<br/> `unix.WithClient()` |
| **database** | Multiple connection pools with MySQL, SQLite, Postgre databases (with automatic migration setup). | `go.osspkg.com/goppy/ormmysql`<br/> `ormmysql.WithMySQL()` <br/> <br/> `go.osspkg.com/goppy/ormsqlite`<br/> `ormsqlite.WithSQLite()`<br/> <br/> `go.osspkg.com/goppy/ormpgsql`<br/> `ormpgsql.WithPostgreSQL()` |
| **geoip** | Definition of geo-IP information. | `go.osspkg.com/goppy/geoip`<br/> `geoip.WithMaxMindGeoIP()` + `geoip.CloudflareMiddleware()`<br/> `geoip.MaxMindMiddleware()` |
| **oauth** | Authorization via OAuth provider (Yandex, Google). JWT Cookie. | `go.osspkg.com/goppy/metrics`<br/> `auth.WithOAuth()`<br/> `auth.WithJWT()` + `auth.JWTGuardMiddleware()` |
| Plugin | Comment | Import |
|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **metrics** | Profiling application (pprof) and metrics collection (prometheus) with access via HTTP. | `go.osspkg.com/goppy/metrics`<br/> `metrics.WithServer()` |
| **http** | Out of the box multi-server launch of web servers with separate routing. Grouping of routers with connection to a group of dedicated middleware. HTTP clients pool. | `go.osspkg.com/goppy/web`<br/> `web.WithServer()`<br/> `web.WithClient()` |
| **websocket** | Ready-made websocket handler for server and client. Websocket server pool. | `go.osspkg.com/goppy/ws`<br/> `ws.WithServer()`<br/> `ws.WithClient()`<br/> `ws.WithServerPool()` |
| **unixsocket** | Requests via unix socket. | `go.osspkg.com/goppy/unix`<br/> `unix.WithServer()`<br/> `unix.WithClient()` |
| **database** | Multiple connection pools with MySQL, SQLite, Postgre databases (with automatic migration setup). | `go.osspkg.com/goppy/ormmysql`<br/> `ormmysql.WithClient()` <br/> <br/> `go.osspkg.com/goppy/ormsqlite`<br/> `ormsqlite.WithClient()`<br/> <br/> `go.osspkg.com/goppy/ormpgsql`<br/> `ormpgsql.WithClient()` |
| **geoip** | Definition of geo-IP information. | `go.osspkg.com/goppy/geoip`<br/> `geoip.WithMaxMindGeoIP()` + `geoip.CloudflareMiddleware()`<br/> `geoip.MaxMindMiddleware()` |
| **oauth** | Authorization via OAuth provider (Yandex, Google). JWT Cookie. | `go.osspkg.com/goppy/auth`<br/> `auth.WithOAuth()`<br/> `auth.WithJWT()` + `auth.JWTGuardMiddleware()` |

## Quick Start

Expand Down Expand Up @@ -69,7 +69,7 @@ func main() {
app.AppName("demo_app")
app.AppVersion("v1.0.0")
app.Plugins(
web.WithHTTP(),
web.WithServer(),
)
app.Plugins(
plugins.Plugin{
Expand Down

0 comments on commit dc6fb5c

Please sign in to comment.