@chronoter/main 0.1.0

package/README.md

@@ -0,0 +1,118 @@
+# Chronoter
+
+MDX-based documentation site generator with development server and Hot Module Replacement (HMR) support.
+
+## Features
+
+- **MDX Support** - Write documentation using MDX (Markdown + JSX)
+- **Development Server** - Fast development server powered by Vite
+- **Hot Module Replacement** - Instant updates without page reload
+- **React Components** - Use React components in your documentation
+- **Tailwind CSS** - Styled with Tailwind CSS out of the box
+
+## Installation
+
+```bash
+npm install -g chronoter
+# or
+yarn global add chronoter
+# or
+pnpm add -g chronoter
+```
+
+Or use it locally in your project:
+
+```bash
+npm install chronoter --save-dev
+```
+
+## Quick Start
+
+1. Create a project directory with your MDX files:
+
+```
+my-docs/
+├── chronoter.config.json  # Optional configuration
+└── docs/
+    ├── index.mdx
+    └── getting-started.mdx
+```
+
+2. Start the development server:
+
+```bash
+chronoter dev
+```
+
+3. Open your browser at `http://localhost:3000`
+
+## Usage
+
+### Development Server
+
+Start the development server with HMR:
+
+```bash
+chronoter dev [options]
+```
+
+#### Options
+
+| Option | Description | Default |
+|--------|-------------|---------|
+| `-p, --port <port>` | Server port number | `3000` |
+| `-H, --host <host>` | Server host | `localhost` |
+| `--no-open` | Disable automatic browser opening | Browser opens by default |
+| `--cwd <path>` | Working directory | Current directory |
+
+#### Examples
+
+```bash
+# Start on port 8080
+chronoter dev --port 8080
+
+# Start without opening browser
+chronoter dev --no-open
+
+# Start in a specific directory
+chronoter dev --cwd ./my-docs
+```
+
+## Configuration
+
+Create a `chronoter.config.json` file in your project root:
+
+```json
+{
+  "site": {
+    "title": "My Documentation",
+    "description": "Documentation for my project"
+  },
+  "docsDir": "docs"
+}
+```
+
+## MDX Files
+
+Write your documentation in MDX format:
+
+```mdx
+---
+title: Getting Started
+---
+
+# Welcome to My Documentation
+
+This is written in **MDX**, so you can use React components:
+
+<MyComponent />
+```
+
+## Requirements
+
+- Node.js 18.0 or higher
+
+## License
+
+This software is proprietary. All rights reserved.
+Commercial use is prohibited without explicit permission from the author.

package/README.npm.md

@@ -0,0 +1,118 @@
+# Chronoter
+
+MDX-based documentation site generator with development server and Hot Module Replacement (HMR) support.
+
+## Features
+
+- **MDX Support** - Write documentation using MDX (Markdown + JSX)
+- **Development Server** - Fast development server powered by Vite
+- **Hot Module Replacement** - Instant updates without page reload
+- **React Components** - Use React components in your documentation
+- **Tailwind CSS** - Styled with Tailwind CSS out of the box
+
+## Installation
+
+```bash
+npm install -g chronoter
+# or
+yarn global add chronoter
+# or
+pnpm add -g chronoter
+```
+
+Or use it locally in your project:
+
+```bash
+npm install chronoter --save-dev
+```
+
+## Quick Start
+
+1. Create a project directory with your MDX files:
+
+```
+my-docs/
+├── chronoter.config.json  # Optional configuration
+└── docs/
+    ├── index.mdx
+    └── getting-started.mdx
+```
+
+2. Start the development server:
+
+```bash
+chronoter dev
+```
+
+3. Open your browser at `http://localhost:3000`
+
+## Usage
+
+### Development Server
+
+Start the development server with HMR:
+
+```bash
+chronoter dev [options]
+```
+
+#### Options
+
+| Option | Description | Default |
+|--------|-------------|---------|
+| `-p, --port <port>` | Server port number | `3000` |
+| `-H, --host <host>` | Server host | `localhost` |
+| `--no-open` | Disable automatic browser opening | Browser opens by default |
+| `--cwd <path>` | Working directory | Current directory |
+
+#### Examples
+
+```bash
+# Start on port 8080
+chronoter dev --port 8080
+
+# Start without opening browser
+chronoter dev --no-open
+
+# Start in a specific directory
+chronoter dev --cwd ./my-docs
+```
+
+## Configuration
+
+Create a `chronoter.config.json` file in your project root:
+
+```json
+{
+  "site": {
+    "title": "My Documentation",
+    "description": "Documentation for my project"
+  },
+  "docsDir": "docs"
+}
+```
+
+## MDX Files
+
+Write your documentation in MDX format:
+
+```mdx
+---
+title: Getting Started
+---
+
+# Welcome to My Documentation
+
+This is written in **MDX**, so you can use React components:
+
+<MyComponent />
+```
+
+## Requirements
+
+- Node.js 18.0 or higher
+
+## License
+
+This software is proprietary. All rights reserved.
+Commercial use is prohibited without explicit permission from the author.