chore: prepare for npm publish

Author: code-with-auto

CONTRIBUTING.md

@@ -0,0 +1,109 @@
+# Contributing to loq
+
+Thanks for your interest in contributing!
+
+## Getting Started
+
+```bash
+# Clone the repo
+git clone https://github.com/code-with-auto/loq.git
+cd loq
+
+# Install dependencies
+bun install
+
+# Run tests
+bun test
+
+# Run in dev mode
+bun run dev
+```
+
+## Development Workflow
+
+1. Fork the repo
+2. Create a feature branch: `git checkout -b feat/my-feature`
+3. Make your changes
+4. Run tests: `bun test`
+5. Run type check: `bun run typecheck`
+6. Commit with conventional commits
+7. Push and open a PR
+
+## Commit Messages
+
+Use conventional commits:
+
+```
+feat: add support for Docker log format
+fix: handle missing timestamp in syslog
+docs: update README with new examples
+test: add coverage for edge cases
+refactor: simplify query executor
+chore: update dependencies
+ci: fix GitHub Actions workflow
+```
+
+## Adding a New Parser
+
+See the [Custom Formats Guide](https://code-with-auto.github.io/loq/guide/custom-formats.html#contributing-built-in-parsers) for detailed instructions.
+
+Quick overview:
+
+1. Create `src/parser/formats/myformat.ts`
+2. Implement `LogParser` interface
+3. Register in `src/parser/auto-detect.ts`
+4. Add tests in `tests/parser/myformat.test.ts`
+5. Submit PR
+
+## Project Structure
+
+```
+loq/
+├── src/
+│   ├── index.ts              # CLI entry point
+│   ├── cli/args.ts           # Argument parsing
+│   ├── config/loader.ts      # Config file loading
+│   ├── parser/
+│   │   ├── types.ts          # Core types
+│   │   ├── auto-detect.ts    # Format detection
+│   │   └── formats/          # Built-in parsers
+│   ├── query/
+│   │   ├── lexer.ts          # Tokenizer
+│   │   ├── parser.ts         # Query parser
+│   │   ├── ast.ts            # AST types
+│   │   └── executor.ts       # Query execution
+│   ├── output/
+│   │   ├── formatter.ts      # Output formatting
+│   │   └── colors.ts         # Terminal colors
+│   └── utils/time.ts         # Time utilities
+├── tests/                    # Test files
+└── docs/                     # VitePress docs
+```
+
+## Code Style
+
+- TypeScript with strict mode
+- No semicolons (Bun default)
+- 2 space indentation
+- Prefer `const` over `let`
+- Use descriptive variable names
+
+## Running Tests
+
+```bash
+# Run all tests
+bun test
+
+# Run specific test file
+bun test tests/parser/json.test.ts
+
+# Run with coverage
+bun test --coverage
+
+# Watch mode
+bun test --watch
+```
+
+## Questions?
+
+Open an issue or start a discussion on GitHub.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 code-with-auto
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package.json

@@ -4,9 +4,15 @@
   "description": "Fast, friendly CLI log analyzer - jq for logs",
   "module": "src/index.ts",
   "type": "module",
+  "main": "src/index.ts",
   "bin": {
     "loq": "./src/index.ts"
   },
+  "files": [
+    "src",
+    "README.md",
+    "LICENSE"
+  ],
   "scripts": {
     "start": "bun run src/index.ts",
     "dev": "bun --watch src/index.ts",
@@ -39,6 +45,10 @@
     "syslog",
     "parser"
   ],
-  "author": "",
-  "license": "MIT"
+  "author": "code-with-auto",
+  "license": "MIT",
+  "homepage": "https://code-with-auto.github.io/loq/",
+  "bugs": {
+    "url": "https://github.com/code-with-auto/loq/issues"
+  }
 }