@cambo-khode/log 1.0.0 → 1.0.3

package/README.md

@@ -0,0 +1,107 @@
+# @cambo-khode/log
+
+A lightweight, colorful, and formatted console logging SDK for Node.js and TypeScript applications.
+
+---
+
+## Features
+
+- 🕒 **Automatic Timestamps** — Automatically prepends local time `[HH:MM:SS]` to every log.
+- 🎨 **Colorized Output** — Built-in terminal colors for different log levels without extra heavy dependencies.
+- 🏷️ **Log Levels** — Dedicated helpers for `info`, `success`, `warning`, `error`, and general `log`.
+- ⚙️ **Configurable** — Customize app name, version, and default log color upon initialization.
+- 📦 **TypeScript Ready** — Full type definitions out of the box.
+
+---
+
+## Installation
+
+Install using your favorite package manager:
+
+```bash
+# npm
+npm install @cambo-khode/log
+
+# yarn
+yarn add @cambo-khode/log
+
+# pnpm
+pnpm add @cambo-khode/log
+```
+
+---
+
+## Quick Start
+
+```typescript
+import { MySDK } from '@cambo-khode/log';
+
+// 1. Initialize the logger
+const logger = new MySDK({
+  appName: 'MyAwesomeApp',
+  version: '1.0.0',
+  color: 'cyan'
+});
+
+// 2. Start logging!
+logger.log('This is a custom default message.');
+logger.info('Database connection established.');
+logger.success('Server started on port 3000!');
+logger.warning('Memory usage is above 80%.');
+logger.error('Failed to connect to redis cache.');
+```
+
+### Sample Output
+
+```text
+[2:45:10 PM] [INFO] MyAwesomeApp v1.0.0 initialized
+[2:45:10 PM] [LOG] This is a custom default message.
+[2:45:10 PM] [INFO] Database connection established.
+[2:45:10 PM] [SUCCESS] Server started on port 3000!
+[2:45:10 PM] [WARNING] Memory usage is above 80%.
+[2:45:10 PM] [ERROR] Failed to connect to redis cache.
+```
+
+---
+
+## Configuration (`SDKConfig`)
+
+You can pass an optional configuration object to `new MySDK(config)`:
+
+| Option | Type | Default | Description |
+| :--- | :--- | :--- | :--- |
+| `appName` | `string` | `'My SDK'` | The name of your application. |
+| `version` | `string` | `'1.0.0'` | The version string displayed on initialization. |
+| `color` | `'red' \| 'green' \| 'yellow' \| 'blue' \| 'cyan' \| 'white'` | `'cyan'` | Default terminal color used for `.log()`. |
+
+### Example with Custom Config
+
+```typescript
+import { MySDK, SDKConfig } from '@cambo-khode/log';
+
+const config: SDKConfig = {
+  appName: 'PaymentService',
+  version: '2.1.0',
+  color: 'yellow' // 'red' | 'green' | 'yellow' | 'blue' | 'cyan' | 'white'
+};
+
+const logger = new MySDK(config);
+```
+
+---
+
+## Available Methods
+
+| Method | Log Tag | Terminal Color | Best Used For |
+| :--- | :--- | :--- | :--- |
+| `logger.log(message)` | `[LOG]` | Custom (Default: `cyan`) | General purpose logs and events |
+| `logger.info(message)` | `[INFO]` | `blue` | Informational status updates |
+| `logger.success(message)` | `[SUCCESS]` | `green` | Successful actions, confirmations |
+| `logger.warning(message)` | `[WARNING]` | `yellow` | Warnings, non-critical alerts |
+| `logger.error(message)` | `[ERROR]` | `red` | Errors, crashes, failed operations |
+
+---
+
+## License
+
+[MIT](LICENSE)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cambo-khode/log",
-  "version": "1.0.0",
+  "version": "1.0.3",
   "description": "Cambo Khode custom console logger SDK",
   "type": "module",
   "main": "./dist/index.js",
@@ -11,9 +11,11 @@
       "import": "./dist/index.js"
     }
   },
-  "files": ["dist"],
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "build": "tsc"
   },
   "license": "MIT"
-}
+}