Kaynağa Gözat

Update package READMEs and add missing documentation

Timothy Pomeroy 1 ay önce
ebeveyn
işleme
ea3fb5e455

+ 7 - 0
README.md

@@ -18,11 +18,13 @@ A modern, full-stack video processing system built with Turborepo. Automatically
 This monorepo contains:
 
 ### Apps
+
 - **`apps/web`**: Next.js 14 web interface with real-time updates
 - **`apps/service`**: NestJS API server with WebSocket support
 - **`apps/cli`**: Node.js command-line interface
 
 ### Packages
+
 - **`packages/eslint-config`**: Shared ESLint configurations
 - **`packages/typescript-config`**: Shared TypeScript configurations
 - **`packages/ui`**: Shared React components (stub)
@@ -45,17 +47,20 @@ pnpm run cli      # Interactive CLI
 ## Development
 
 ### Prerequisites
+
 - Node.js 20+
 - pnpm package manager
 - HandBrake CLI (installed automatically in Docker)
 
 ### Available Scripts
+
 - `pnpm run dev` - Start all services with hot reload
 - `pnpm run build` - Build all apps
 - `pnpm run lint` - Run ESLint
 - `pnpm run test` - Run tests
 
 ### Docker Support
+
 ```bash
 docker build .
 docker-compose up
@@ -64,6 +69,7 @@ docker-compose up
 ## Configuration
 
 Dataset configurations are stored in the SQLite database. Each dataset defines:
+
 - Watch directories
 - Output destinations
 - File extensions to process
@@ -93,6 +99,7 @@ pnpm run cli config:get datasets
 ## Database
 
 SQLite database stored at `data/database.db` containing:
+
 - **files**: Processed video metadata
 - **tasks**: Processing queue
 - **settings**: Configuration data

+ 39 - 2
packages/eslint-config/README.md

@@ -1,3 +1,40 @@
-# `@turbo/eslint-config`
+# ESLint Configuration
 
-Collection of internal eslint configurations.
+Shared ESLint configurations for the Watch Finished Turbo monorepo.
+
+## Configurations
+
+- **`base.js`** - Base ESLint configuration with TypeScript support
+- **`next.js`** - Next.js specific ESLint rules
+- **`react-internal.js`** - React component library rules
+
+## Usage
+
+In `package.json`:
+
+```json
+{
+  "eslintConfig": {
+    "extends": ["@watch-finished-turbo/eslint-config/base"]
+  }
+}
+```
+
+Or in `eslint.config.js`:
+
+```js
+import baseConfig from "@watch-finished-turbo/eslint-config/base";
+
+export default [
+  ...baseConfig,
+  // Your custom rules
+];
+```
+
+## Included Rules
+
+- TypeScript strict type checking
+- React best practices
+- Next.js specific rules
+- Import/export validation
+- Code formatting consistency

+ 29 - 0
packages/typescript-config/README.md

@@ -0,0 +1,29 @@
+# TypeScript Configuration
+
+Shared TypeScript configurations for the Watch Finished Turbo monorepo.
+
+## Configurations
+
+- **`base.json`** - Base TypeScript configuration
+- **`nextjs.json`** - Next.js specific TypeScript settings
+- **`react-library.json`** - React component library configuration
+
+## Usage
+
+In `tsconfig.json`:
+
+```json
+{
+  "extends": "@watch-finished-turbo/typescript-config/base",
+  "compilerOptions": {
+    // Your custom options
+  }
+}
+```
+
+## Features
+
+- Strict type checking enabled
+- Modern ESNext target
+- Path mapping for monorepo imports
+- React and Next.js specific settings

+ 28 - 0
packages/ui/README.md

@@ -0,0 +1,28 @@
+# UI Components
+
+Shared React UI components for the Watch Finished Turbo monorepo.
+
+## Status
+
+This package is currently a stub and contains minimal shared components. Future development may expand this into a comprehensive component library.
+
+## Usage
+
+```tsx
+import { Component } from "@watch-finished-turbo/ui";
+
+// Use shared components across apps
+```
+
+## Current Components
+
+- Placeholder for future shared UI components
+- Tailwind CSS utilities
+- Common component patterns
+
+## Development
+
+This package follows the same development practices as the main apps:
+- TypeScript for type safety
+- ESLint for code quality
+- Tailwind CSS for styling