feat: added documentation

Author: jayemscript

README.md

@@ -1,2 +1,88 @@
 # pretty-log
+
 Make console logs readable with clean, structured, tag-based output.
+
+## Installation
+
+```bash
+npm install pretty-log
+```
+
+## Usage
+
+```ts
+import { clog } from 'pretty-log';
+
+clog.user({ id: 1, name: 'Jay' });
+clog.error('Something went wrong');
+clog.payment({ amount: 99.99, currency: 'USD' });
+clog.server('Listening on port 3000');
+```
+
+The dot notation is the tag. Any property you access becomes the label of that log line. All built-in tags are pre-styled, and any unknown tag falls back to a default style automatically.
+
+## Built-in Tags
+
+| Tag       | Console Method |
+|-----------|----------------|
+| info      | console.info   |
+| success   | console.log    |
+| warn      | console.warn   |
+| error     | console.error  |
+| debug     | console.debug  |
+| user      | console.log    |
+| auth      | console.log    |
+| db        | console.log    |
+| api       | console.log    |
+| server    | console.log    |
+| request   | console.log    |
+| response  | console.log    |
+| cache     | console.log    |
+| job       | console.log    |
+| event     | console.log    |
+| mail      | console.log    |
+| payment   | console.log    |
+| socket    | console.log    |
+| test      | console.log    |
+
+## Custom Logger
+
+```ts
+import { createLogger } from 'pretty-log';
+
+const log = createLogger({
+  timestamp: true,   // show ISO timestamp, default: true
+  silent: false,     // suppress all output, default: false
+  tags: {
+    stripe: { fg: 'black', bg: 'brightGreen', level: 'log' },
+    redis:  { fg: 'white', bg: 'red',         level: 'warn' },
+  },
+});
+
+log.stripe({ event: 'charge.succeeded' });
+log.redis('Cache miss');
+```
+
+## Options
+
+| Option      | Type    | Default | Description                        |
+|-------------|---------|---------|------------------------------------|
+| `timestamp` | boolean | `true`  | Prepend ISO timestamp to each log  |
+| `silent`    | boolean | `false` | Suppress all output                |
+| `tags`      | object  | `{}`    | Add or override tag definitions    |
+
+## Tag Config
+
+Each tag entry accepts the following fields:
+
+```ts
+{
+  fg: FgColor,                              // foreground color
+  bg: BgColor,                              // background color
+  level: 'log' | 'info' | 'warn' | 'error' | 'debug'
+}
+```
+
+## License
+
+MIT

docs/CONTRIBUTING.md

@@ -0,0 +1,71 @@
+# Contributing
+
+Contributions are welcome. Please read this guide before submitting a pull request.
+
+## Getting Started
+
+```bash
+git clone https://github.com/jayemscript/pretty-log.git
+cd pretty-log
+npm install
+```
+
+## Development
+
+Run the tests:
+
+```bash
+npm test
+```
+
+Type check without building:
+
+```bash
+npm run lint
+```
+
+Build the package:
+
+```bash
+npm run build
+```
+
+## Project Structure
+
+```
+src/
+  index.ts          - public exports
+  logger.ts         - core logger and createLogger factory
+  lib/
+    tags.ts         - built-in tag definitions
+  utils/
+    colors.ts       - ANSI color codes
+    formatter.ts    - timestamp, label, and data formatting
+test/
+  logger.test.ts    - all tests
+```
+
+## Guidelines
+
+- Keep changes focused. One feature or fix per pull request.
+- Add or update tests for any changed behavior.
+- Make sure `npm test` and `npm run lint` pass before submitting.
+- Follow the existing code style — strict TypeScript, no external runtime dependencies.
+
+## Adding a Built-in Tag
+
+Open `src/lib/tags.ts` and add an entry to `DEFAULT_TAGS`:
+
+```ts
+mytag: { fg: 'black', bg: 'brightCyan', level: 'log' },
+```
+
+That is all that is needed. The Proxy in `logger.ts` picks it up automatically.
+
+## Reporting Issues
+
+Open an issue on GitHub with a clear description and a minimal reproduction if possible.
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the MIT license.

docs/SECURITY.md

@@ -0,0 +1,22 @@
+# Security Policy
+
+## Supported Versions
+
+Only the latest version of pretty-log receives security updates.
+
+| Version | Supported |
+|---------|-----------|
+| latest  | yes       |
+| older   | no        |
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability, do not open a public GitHub issue.
+
+Instead, report it privately by emailing the maintainer directly. Include as much detail as possible — a description of the issue, steps to reproduce, and any potential impact.
+
+You can expect an acknowledgment within 48 hours and a resolution or status update within 7 days.
+
+## Scope
+
+pretty-log is a logging utility with no network access, no file system writes, and no external runtime dependencies. The attack surface is limited to console output formatting. That said, any confirmed vulnerability will be taken seriously and patched promptly.