docs: improve README and add community files

Polliog · Polliog · commit 0a3a3d01251b · 2026-01-13T18:48:28.000+01:00
- Enhance README with centered logo, badges, and better structure
- Add CONTRIBUTING.md with development guidelines
- Add CODE_OF_CONDUCT.md based on Contributor Covenant
- Add CHANGELOG.md following Keep a Changelog format
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,29 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2026-01-13
+
+### Added
+
+- Initial release of LogTide Node.js SDK
+- Automatic batching with configurable size and interval
+- Retry logic with exponential backoff
+- Circuit breaker pattern for fault tolerance
+- Max buffer size with drop policy
+- Query API for searching and filtering logs
+- Live tail with Server-Sent Events (SSE)
+- Trace ID context for distributed tracing
+- Global metadata support
+- Structured error serialization
+- Internal metrics tracking
+- Logging methods: debug, info, warn, error, critical
+- Express middleware for auto-logging HTTP requests
+- Fastify plugin for auto-logging HTTP requests
+- Full TypeScript support with strict types
+- ESM and CommonJS module support
+
+[0.1.0]: https://github.com/logtide-dev/logtide-sdk-node/releases/tag/v0.1.0
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,35 @@
+# Code of Conduct
+
+## Our Pledge
+
+We are committed to providing a welcoming and inclusive environment for everyone, regardless of background or identity.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment:
+
+- Being respectful and inclusive
+- Accepting constructive criticism gracefully
+- Focusing on what is best for the community
+- Showing empathy towards others
+
+Examples of unacceptable behavior:
+
+- Harassment, trolling, or insulting comments
+- Personal or political attacks
+- Publishing others' private information without permission
+- Other conduct that would be inappropriate in a professional setting
+
+## Enforcement
+
+Project maintainers have the right to remove, edit, or reject comments, commits, code, issues, and other contributions that are not aligned with this Code of Conduct.
+
+## Reporting
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at **support@logtide.dev**.
+
+All complaints will be reviewed and investigated promptly and fairly.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,74 @@
+# Contributing to LogTide Node.js SDK
+
+Thank you for your interest in contributing!
+
+## Development Setup
+
+1. Clone the repository:
+```bash
+git clone https://github.com/logtide-dev/logtide-sdk-node.git
+cd logtide-sdk-node
+```
+
+2. Install dependencies:
+```bash
+pnpm install
+```
+
+3. Build the project:
+```bash
+pnpm build
+```
+
+## Code Style
+
+- Follow [TypeScript Best Practices](https://www.typescriptlang.org/docs/handbook/declaration-files/do-s-and-don-ts.html)
+- Use strict TypeScript with no implicit any
+- Format code with [Prettier](https://prettier.io/)
+- Lint with [ESLint](https://eslint.org/)
+- Use meaningful variable and function names
+- Add JSDoc comments for public APIs
+
+## Testing
+
+```bash
+# Run tests
+pnpm test
+
+# Run tests in watch mode
+pnpm test:watch
+
+# Run tests with coverage
+pnpm test:coverage
+
+# Type checking
+pnpm typecheck
+
+# Linting
+pnpm lint
+
+# Format code
+pnpm format
+```
+
+## Pull Request Process
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Make your changes
+4. Ensure tests pass (`pnpm test`)
+5. Lint and format code (`pnpm lint && pnpm format`)
+6. Commit your changes (`git commit -m 'Add amazing feature'`)
+7. Push to the branch (`git push origin feature/amazing-feature`)
+8. Open a Pull Request
+
+## Reporting Issues
+
+- Use the GitHub issue tracker
+- Provide clear description and reproduction steps
+- Include Node.js version and OS information
+- Include relevant logs and error messages
+
+## Questions?
+
+Feel free to open an issue for any questions or discussions!
diff --git a/README.md b/README.md
@@ -1,21 +1,36 @@
-# LogTide Node.js SDK
+<p align="center">
+  <img src="https://raw.githubusercontent.com/logtide-dev/logtide/main/docs/images/logo.png" alt="LogTide Logo" width="400">
+</p>
 
-Official Node.js SDK for LogTide with advanced features: retry logic, circuit breaker, query API, live streaming, and middleware support.
+<h1 align="center">LogTide Node.js SDK</h1>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@logtide/sdk-node"><img src="https://img.shields.io/npm/v/@logtide/sdk-node?color=blue" alt="npm"></a>
+  <a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License"></a>
+  <a href="https://nodejs.org/"><img src="https://img.shields.io/badge/Node.js-18+-green.svg" alt="Node.js"></a>
+  <a href="https://github.com/logtide-dev/logtide-sdk-node/releases"><img src="https://img.shields.io/github/v/release/logtide-dev/logtide-sdk-node" alt="Release"></a>
+</p>
+
+<p align="center">
+  Official Node.js SDK for <a href="https://logtide.dev">LogTide</a> with automatic batching, retry logic, circuit breaker, query API, live streaming, and middleware support.
+</p>
+
+---
 
 ## Features
 
-- ✅ **Automatic batching** with configurable size and interval
-- ✅ **Retry logic** with exponential backoff
-- ✅ **Circuit breaker** pattern for fault tolerance
-- ✅ **Max buffer size** with drop policy to prevent memory leaks
-- ✅ **Query API** for searching and filtering logs
-- ✅ **Live tail** with Server-Sent Events (SSE)
-- ✅ **Trace ID context** for distributed tracing
-- ✅ **Global metadata** added to all logs
-- ✅ **Structured error serialization**
-- ✅ **Internal metrics** (logs sent, errors, latency, etc.)
-- ✅ **Express & Fastify middleware** for auto-logging HTTP requests
-- ✅ **Full TypeScript support** with strict types
+- **Automatic batching** with configurable size and interval
+- **Retry logic** with exponential backoff
+- **Circuit breaker** pattern for fault tolerance
+- **Max buffer size** with drop policy to prevent memory leaks
+- **Query API** for searching and filtering logs
+- **Live tail** with Server-Sent Events (SSE)
+- **Trace ID context** for distributed tracing
+- **Global metadata** added to all logs
+- **Structured error serialization**
+- **Internal metrics** (logs sent, errors, latency, etc.)
+- **Express & Fastify middleware** for auto-logging HTTP requests
+- **Full TypeScript support** with strict types
 
 ## Installation
 
@@ -89,7 +104,7 @@ const client = new LogTideClient({
   // Buffer management
   maxBufferSize: 10000,
 
-  // Retry with exponential backoff (1s → 2s → 4s)
+  // Retry with exponential backoff (1s -> 2s -> 4s)
   maxRetries: 3,
   retryDelayMs: 1000,
 
@@ -158,9 +173,9 @@ client.log({
   service: 'custom-service',
   level: 'info',
   message: 'Custom log',
-  time: new Date().toISOString(), // Optional
+  time: new Date().toISOString(),
   metadata: { key: 'value' },
-  trace_id: 'custom-trace-id', // Optional
+  trace_id: 'custom-trace-id',
 });
 ```
 
@@ -201,16 +216,6 @@ client.withNewTraceId(() => {
 });
 ```
 
-### Auto Trace ID Mode
-
-```typescript
-const client = new LogTideClient({
-  apiUrl: 'http://localhost:8080',
-  apiKey: 'lp_your_api_key_here',
-  autoTraceId: true, // Every log gets a unique trace ID
-});
-```
-
 ---
 
 ## Query API
@@ -315,7 +320,9 @@ client.resetMetrics();
 
 ---
 
-## Middleware
+## Middleware Integration
+
+LogTide provides ready-to-use middleware for popular frameworks.
 
 ### Express Middleware
 
@@ -385,6 +392,17 @@ await fastify.listen({ port: 3000 });
 
 ---
 
+## Examples
+
+See the [examples/](./examples) directory for complete working examples:
+
+- **[basic.ts](./examples/basic.ts)** - Simple usage
+- **[advanced.ts](./examples/advanced.ts)** - All advanced features
+- **[express-middleware.ts](./examples/express-middleware.ts)** - Express integration
+- **[fastify-plugin.ts](./examples/fastify-plugin.ts)** - Fastify integration
+
+---
+
 ## Best Practices
 
 ### 1. Always Close on Shutdown
@@ -442,72 +460,6 @@ setInterval(() => {
 }, 60000);
 ```
 
-### 5. Use Trace IDs for Request Correlation
-
-```typescript
-app.use((req, res, next) => {
-  const traceId = req.headers['x-trace-id'] || randomUUID();
-  req.traceId = traceId;
-
-  client.withTraceId(traceId, () => {
-    next();
-  });
-});
-```
-
----
-
-## API Reference
-
-### LogTideClient
-
-#### Constructor
-```typescript
-new LogTideClient(options: LogTideClientOptions)
-```
-
-#### Logging Methods
-- `log(entry: LogEntry): void`
-- `debug(service: string, message: string, metadata?: object): void`
-- `info(service: string, message: string, metadata?: object): void`
-- `warn(service: string, message: string, metadata?: object): void`
-- `error(service: string, message: string, metadataOrError?: object | Error): void`
-- `critical(service: string, message: string, metadataOrError?: object | Error): void`
-
-#### Context Methods
-- `setTraceId(traceId: string | null): void`
-- `getTraceId(): string | null`
-- `withTraceId<T>(traceId: string, fn: () => T): T`
-- `withNewTraceId<T>(fn: () => T): T`
-
-#### Query Methods
-- `query(options: QueryOptions): Promise<LogsResponse>`
-- `getByTraceId(traceId: string): Promise<InternalLogEntry[]>`
-- `getAggregatedStats(options: AggregatedStatsOptions): Promise<AggregatedStatsResponse>`
-
-#### Streaming
-- `stream(options: StreamOptions): () => void` (returns cleanup function)
-
-#### Metrics
-- `getMetrics(): ClientMetrics`
-- `resetMetrics(): void`
-- `getCircuitBreakerState(): string`
-
-#### Lifecycle
-- `flush(): Promise<void>`
-- `close(): Promise<void>`
-
----
-
-## Examples
-
-See the [examples/](./examples) directory for complete working examples:
-
-- **[basic.ts](./examples/basic.ts)** - Simple usage
-- **[advanced.ts](./examples/advanced.ts)** - All advanced features
-- **[express-middleware.ts](./examples/express-middleware.ts)** - Express integration
-- **[fastify-plugin.ts](./examples/fastify-plugin.ts)** - Fastify integration
-
 ---
 
 ## TypeScript Support
@@ -526,36 +478,16 @@ import type {
 
 ---
 
-## Testing
-
-Run the test suite:
-
-```bash
-# Run tests
-pnpm test
-
-# Watch mode
-pnpm test:watch
-
-# Coverage
-pnpm test:coverage
-```
+## Contributing
 
----
+Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
 
 ## License
 
-MIT
-
----
-
-## Contributing
-
-Contributions are welcome! Please open an issue or PR on [GitHub](https://github.com/logtide-dev/logtide-sdk-node).
-
----
+MIT License - see [LICENSE](LICENSE) for details.
 
-## Support
+## Links
 
-- **Documentation**: [https://logtide.dev/docs](https://logtide.dev/docs)
-- **Issues**: [GitHub Issues](https://github.com/logtide-dev/logtide-sdk-node/issues)
+- [LogTide Website](https://logtide.dev)
+- [Documentation](https://logtide.dev/docs/sdks/node/)
+- [GitHub Issues](https://github.com/logtide-dev/logtide-sdk-node/issues)
