feat(optional): add startup message config

PunGrumpy · Sep 26, 2024 · c7a76db · c7a76db
1 parent b68696f
commit c7a76db
Showing 1 changed file with 3 additions and 2 deletions.
diff --git 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`                                                                    |