From c7a76dbc0f30f4c9c607b52dedc49979e26b67ec Mon Sep 17 00:00:00 2001 From: PunGrumpy <108584943+PunGrumpy@users.noreply.github.com> Date: Fri, 27 Sep 2024 02:50:02 +0700 Subject: [PATCH] feat(optional): add startup message config --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7184bf8..67dcf91 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,8 @@ const app = new Elysia({ }).use( logixlysia({ config: { - showBanner: true, + showStartupMessage: true, + startupMessageFormat: 'simple', ip: true, logFilePath: './logs/example.log', customLogFormat: @@ -48,7 +49,7 @@ app.listen(3000) | Option | Type | Description | Default | | ---------------------- | ------------------------ | --------------------------------------------------------------------- | ------------------------------------------------------------------------- | | `showStartupMessage` | `boolean` | Display the startup message | `true` | -| `startupMessageFormat` | `"banner"` \| `"simple"` | Choose the startup message format | `"banner"` | +| `startupMessageFormat` | `"banner"` \| `"simple"` | Choose the startup message format | `"banner"` | | `ip` | `boolean` | Display the incoming IP address based on the `X-Forwarded-For` header | `false` | | `customLogMessage` | `string` | Custom log message to display | `🦊 {now} {level} {duration} {method} {pathname} {status} {message} {ip}` | | `logFilter` | `object` | Filter the logs based on the level, method, and status | `null` |