Skip to content

Self-improving AI Employees for everyone

update readme

trohitgbda7bd564c69
diff --git a/README.md b/README.md
index 813e32cc..fc670ff2 100644
--- a/README.md
+++ b/README.md
@@ -2,62 +2,58 @@
Visual workflow automation platform. Build workflows by connecting nodes - like n8n or Zapier.
-## Docker Setup (Recommended)
+## Quick Start
```bash
git clone https://github.com/trohitg/MachinaOS.git
cd MachinaOs
-npm run docker:build
-npm run docker:up
+npm run docker:build && npm run docker:up
```
Open http://localhost:3000
-| Command | Description |
-|---------|-------------|
-| `npm run docker:up` | Start containers |
-| `npm run docker:down` | Stop containers |
-| `npm run docker:logs` | View logs |
-| `npm run docker:build` | Rebuild images |
-
-**Redis (optional):** Set `REDIS_ENABLED=true` in `.env` to enable Redis caching.
-
## Local Development
**Prerequisites:** Node.js 18+, Python 3.10+, Go 1.21+
```bash
-git clone https://github.com/trohitg/MachinaOS.git
-cd MachinaOs
npm run build
npm run start
```
-Open http://localhost:3000 and register your account.
-
---
-## What You Can Build
+## Features
+
+- **AI Workflows** - OpenAI, Claude, Gemini models
+- **Android Automation** - Control your phone
+- **WhatsApp Bots** - Send/receive messages
+- **HTTP/Webhooks** - API integrations
-- **AI Workflows** - Connect OpenAI, Claude, Gemini models
-- **Android Automation** - Control your phone (battery, WiFi, apps, sensors)
-- **WhatsApp Bots** - Send/receive messages, auto-replies
-- **HTTP/Webhooks** - API integrations, triggers
+## Docker Commands
-## How It Works
+| Command | Description |
+|---------|-------------|
+| `npm run docker:up` | Start containers |
+| `npm run docker:down` | Stop containers |
+| `npm run docker:logs` | View logs |
+| `npm run docker:build` | Rebuild images |
-1. Drag nodes onto canvas
-2. Connect them together
-3. Configure each node
-4. Click Run
+**Redis (optional):** Set `REDIS_ENABLED=true` in `.env`
-## Commands
+## Local Commands
| Command | Description |
|---------|-------------|
| `npm run start` | Start all services |
| `npm run stop` | Stop all services |
-| `npm run build` | Install all dependencies |
+| `npm run build` | Install dependencies |
+
+## Configuration
+
+**API Keys:** Click **Credentials** button in toolbar to add API keys for OpenAI, Claude, Google Maps, etc.
+
+**Environment:** Edit `.env` for auth settings, ports, and database location.
## Project Structure
@@ -69,12 +65,6 @@ MachinaOs/
└── package.json
```
-## Configuration
-
-**API Keys:** Click the **Credentials** button (key icon) in the top toolbar to add API keys for OpenAI, Claude, Google Maps, etc.
-
-**Environment:** Edit `.env` in the project root for authentication settings, ports, and database location.
-
## Tech Stack
- **Frontend:** React, TypeScript, React Flow