sachii-safe-logger 1.1.5 → 1.1.6

package/README.md

@@ -1,21 +1,114 @@
-# Safe Logger
+# sachii-safe-logger
 
-`safe-logger` is a lightweight TypeScript library for safely masking sensitive information such as **emails, phone numbers, credit card numbers, and tokens**. It’s useful for logging or displaying user data without exposing private details.
+![npm](https://img.shields.io/npm/v/sachii-safe-logger)
+![npm downloads](https://img.shields.io/npm/dt/sachii-safe-logger)
+![TypeScript](https://img.shields.io/badge/TypeScript-Yes-blue)
+![License](https://img.shields.io/npm/l/sachii-safe-logger)
+
+`sachii-safe-logger` is a lightweight **TypeScript library** for safely logging sensitive data by masking information such as **phone numbers, email addresses, credit card numbers, and tokens**. Ideal for logging, debugging, or displaying user data without exposing sensitive details.
 
 ---
 
-## Features
+## 🔹 Features
 
-- Mask email addresses
-- Mask phone numbers
-- Mask credit card numbers
-- Mask tokens or keys
-- Fully written in TypeScript
-- Works in Node.js and frontend projects
+- Mask **phone numbers** for privacy.
+- Mask **email addresses** partially.
+- Mask **credit card numbers** leaving only the last 4 digits.
+- Mask **tokens or API keys** securely.
+- Written in **TypeScript**, with types included.
+- Lightweight, dependency-free, and easy to use.
 
 ---
+npm package link
+[https://www.npmjs.com/package/sachii-safe-logger](https://www.npmjs.com/package/sachii-safe-logger)
 
-## Installation
+## 💾 Installation
 
 ```bash
-npm install safe-logger
+npm install sachii-safe-logger
+
+```Importing
+import { maskPhone, maskEmail, maskCreditCard, maskToken } from "sachii-safe-logger";
+
+```Usage
+const phone = "9876543210";
+console.log(maskPhone(phone)); 
+// Output: *******210
+
+
+
+const email = "example@example.com";
+console.log(maskEmail(email)); 
+// Output: e*****@example.com
+
+
+
+const creditCard = "1234567890123456";
+console.log(maskCreditCard(creditCard)); 
+// Output: ************3456
+
+
+
+const token = "abc123def456";
+console.log(maskToken(token)); 
+// Output: **123**
+
+```
+
+
+| Function           | Description                                    | Example                |
+| ------------------ | ---------------------------------------------- | ---------------------- |
+| `maskEmail()`      | Masks email except first letter and domain     | `"s*****@example.com"` |
+| `maskPhone()`      | Masks phone except last 3 digits               | `"*******210"`         |
+| `maskCreditCard()` | Masks all except last 4 digits                 | `"************1111"`   |
+| `maskToken()`      | Masks API tokens except first 4 & last 4 chars | `"abcd********5678"`   |
+
+---
+
+Contributing
+
+PRs welcome! Please follow code style and add tests.
+
+## 📁 File Structure
+
+
+sachii-safe-logger/
+├─ dist/
+│  ├─ maskers/
+│  │  ├─ creditCard.js
+│  │  ├─ email.js
+│  │  ├─ phone.js
+│  │  └─ tokens.js
+│  └─ utils.js
+├─ tests/
+│  ├─ phone.test.ts
+│  ├─ email.test.ts
+│  ├─ creditCard.test.ts
+│  └─ token.test.ts
+├─ package.json
+├─ README.md
+└─ LICENSE
+
+```
+
+---
+
+## Documentation
+[Full API docs](https://sachiinandan.github.io/sachii-safe-logger)
+
+
+## 📝 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+---
+
+## 📝 Contributing
+
+Please read our [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
+
+---
+
+## 📝 Author
+
+- **Sachinandan** - [Sachinandan](https://github.com/sachinandan-05)

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "sachii-safe-logger",
-    "version": "1.1.5",
+    "version": "1.1.6",
     "description": "A lightweight TypeScript library to mask sensitive data (emails, credit cards, phone numbers, API tokens) in logs for security and compliance.",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",