diff --git a/changelog.md b/changelog.md index 7f2d3eb..d957245 100644 --- a/changelog.md +++ b/changelog.md @@ -1,5 +1,13 @@ # Changelog +## 2025-08-25 - 1.7.0 - feat(readme) +Add comprehensive README with detailed usage, command reference, daemon management, architecture and development instructions + +- Expanded README from a short placeholder to a full documentation covering: Quick Start, Installation, Command Reference, Daemon Management, Monitoring & Information, Batch Operations, Architecture, Programmatic Usage, Advanced Features, Development, Debugging, Performance, and Legal information +- Included usage examples and CLI command reference for start/stop/restart/delete/list/describe/logs and batch/daemon commands +- Added human-friendly memory formatting and examples, process and daemon status outputs, and programmatic TypeScript usage snippet +- Improved onboarding instructions: cloning, installing, testing, building, and running the project + ## 2025-08-25 - 1.6.1 - fix(daemon) Fix smartipc integration and add daemon/ipc integration tests diff --git a/readme.md b/readme.md index db5d34c..a8770e0 100644 --- a/readme.md +++ b/readme.md @@ -1,7 +1,340 @@ -# @git.zone/tspm +# @git.zone/tspm 🚀 -a no fuzz process manager +**TypeScript Process Manager** - A robust, no-fuss process manager designed specifically for TypeScript and Node.js applications. Built for developers who need reliable process management without the complexity. -## How to create the docs +## 🎯 What TSPM Does -To create docs run gitzone aidoc. +TSPM is your production-ready process manager that handles the hard parts of running Node.js applications: + +- **Automatic Memory Management** - Set memory limits and let TSPM handle the rest +- **Smart Auto-Restart** - Crashed processes come back automatically (when you want them to) +- **File Watching** - Auto-restart on file changes during development +- **Process Groups** - Track parent and child processes together +- **Daemon Architecture** - Survives terminal sessions with a persistent background daemon +- **Beautiful CLI** - Clean, informative terminal output with real-time status +- **Structured Logging** - Capture and manage stdout/stderr with intelligent buffering +- **Zero Config** - Works out of the box, customize when you need to + +## 📦 Installation + +```bash +# Install globally +npm install -g @git.zone/tspm + +# Or with pnpm (recommended) +pnpm add -g @git.zone/tspm + +# Or use in your project +npm install --save-dev @git.zone/tspm +``` + +## 🚀 Quick Start + +```bash +# Start the daemon (happens automatically on first use) +tspm daemon start + +# Start a process +tspm start server.js --name my-server + +# Start with memory limit +tspm start app.js --memory 512MB --name my-app + +# Start with file watching (great for development) +tspm start dev.js --watch --name dev-server + +# List all processes +tspm list + +# Check process details +tspm describe my-server + +# View logs +tspm logs my-server --lines 100 + +# Stop a process +tspm stop my-server + +# Restart a process +tspm restart my-server +``` + +## 📋 Command Reference + +### Process Management + +#### `tspm start