@wlix/logger 1.0.0 → 1.0.1

package/README.md

@@ -6,21 +6,29 @@ A tiny file-based logger for Node.js projects. It writes logs to daily files and
 
 -   When you create a `Logger`, it ensures the logs directory exists.
 -   Each day gets its own log file named `DD-MM-YYYY.log`.
--   Every log line includes UTC time, log level, and your message.
+-   Every log line includes UTC time (or UTC offset), log level, and your message.
 -   Logs are then written to the file automatically.
 
 ## Usage
 
 -   Instantiate a new Logger instance.
--   Use `Logger#info()`, `Logger#warn()`, or `Logger#error()` with a message.
+-   Use the returned function with `"info" | "warn" | "error"` and your message.
 -   Files are written to the `./logs` dir by default.
 
 ```ts
 import { Logger } from "./Logger";
 
-const logger = new Logger({ logToStdout: true });
+const logger = Logger();
 
-logger.info("Connected to server");
-logger.warn("Memory is low");
-logger.error("Something went wrong");
+logger("info", "Connected to server");
+logger("warn", "Memory is low");
+logger("error", "Something went wrong");
 ```
+
+## Configuration
+
+| Option        | Type                    | Default    | Description                                                      |
+| ------------- | ----------------------- | ---------- | ---------------------------------------------------------------- |
+| `logsPath`    | `string`                | `"./logs"` | Path of the directory where log files are stored                 |
+| `logToStdout` | `boolean`               | `true`     | Whether to print logs to the console                             |
+| `timezone`    | `"UTC"` \| `UTC±number` | `"UTC"`    | Timezone for log timestamps, e.g., `"UTC"`, `"UTC+3"`, `"UTC-6"` |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wlix/logger",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A simple logger.",
   "main": "index.js",
   "types": "index.d.ts",