Skip to content

Commit 8770133

Browse files
committed
feat(docs): Complete Overhaul of README.md for v11+ and AI-Native Focus #7778
1 parent b980d01 commit 8770133

1 file changed

Lines changed: 68 additions & 53 deletions

File tree

README.md

Lines changed: 68 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,16 @@
1111
<a href="./CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-welcome-green.svg?logo=GitHub&logoColor=white" alt="PRs Welcome"></a>
1212
</p>
1313

14-
# Build Ultra-Fast, Desktop-Like Web Apps
15-
🚀 **Break Free from UI FreezesExperience True Multithreading & Uncompromised Responsiveness.**
14+
# The AI-Native Platform for Ultra-Fast Web Apps
15+
🚀 **True Multithreading Meets Context EngineeringBuild Desktop-Class UIs with an AI Co-Developer.**
1616

17-
💻 ***Neo.mjs isn't just an upgrade — it's a new operating system for the web. Where others optimize at the margins, we reinvented the engine.***
17+
💻 ***Neo.mjs is more than a framework; it's a new operating system for the web, architected for unparalleled performance and pioneering human-AI collaboration.***
1818

19-
Imagine web applications that never jank, no matter how complex the logic, how many real-time updates they handle, or how
20-
many browser windows they span. Neo.mjs is engineered from the ground up to deliver **desktop-like fluidity and scalability**.
21-
**While it excels for Single Page Apps (SPAs), Neo.mjs is simply the best option for browser-based multi-window applications**,
22-
operating fundamentally different from traditional frameworks.
19+
Imagine web applications that never jank, no matter how complex the logic, how many real-time updates they handle, or how many browser windows they span. Neo.mjs is engineered from the ground up to deliver **desktop-like fluidity and scalability**. **While it excels for Single Page Apps (SPAs), Neo.mjs is simply the best option for browser-based multi-window applications**, operating fundamentally different from traditional frameworks.
2320

24-
By leveraging a **pioneering Off-Main-Thread (OMT) architecture**, Neo.mjs ensures your UI remains butter-smooth, even during computationally intensive tasks like complex data processing or advanced graphics rendering. The main thread is kept free for one purpose: **flawless user interactions and seamless DOM updates.**
21+
By leveraging a **pioneering Off-Main-Thread (OMT) architecture**, Neo.mjs ensures your UI remains butter-smooth. The main thread is kept free for one purpose: **flawless user interactions and seamless DOM updates.**
22+
23+
But performance is only half the story. With v11, Neo.mjs becomes the world's first **AI-native** frontend platform, designed to be developed *with* AI agents as first-class partners in your workflow.
2524

2625
<p align="center">
2726
<a href="https://youtu.be/pYfM28Pz6_0"><img height="316px" width="400px" src="https://raw.githubusercontent.com/neomjs/pages/master/resources_pub/images/neo33s.png" alt="Neo.mjs Performance Demo 1 (YouTube Video)"></a>
@@ -37,45 +36,51 @@ Have a question or want to connect with the community? We have two channels to h
3736
* **[⚡️ Slack (For Real-Time Chat)](https://join.slack.com/t/neomjs/shared_invite/zt-6c50ueeu-3E1~M4T9xkNnb~M_prEEOA):** Perfect for quick, real-time conversations. Please note that the free version's history is temporary (messages are deleted after 90 days).
3837

3938
</br></br>
40-
## 🚀 Why Choose Neo.mjs? Solving the Toughest UI Challenges
41-
Traditional single-threaded frontend frameworks often struggle with performance bottlenecks and UI freezes, especially for
42-
large-scale, data-intensive, or real-time applications. Neo.mjs offers a fundamentally different solution, designed for
43-
**uncompromising performance, enhanced security, and superior developer experience.**
44-
45-
1. **Eliminate UI Freezes with True Multithreading**:
46-
> *"The browser's main thread should be treated like a neurosurgeon: only perform precise, scheduled operations with zero distractions."*</br></br>
47-
— Neo.mjs Core Philosophy
48-
49-
Neo.mjs's OMT architecture inherently prevents UI freezes. With v10's optimized rendering pipeline, your UI will remain even *more*
50-
consistently responsive, even during intense data processing or complex graphics rendering. It achieves an astonishing
51-
rate of **over 40,000 delta updates per second** in optimized environments. This translates to an engine with vast untapped
52-
potential, limited only by user interaction, not the framework.
53-
54-
2. **Unmatched Developer Experience: Transpilation-Free ESM**:
55-
Say goodbye to complex build steps for development. Neo.mjs apps run **natively as ES Modules directly in the browser**.
56-
This means **zero builds or transpilations** in dev mode, offering instant reloads and an **unmatched debugging experience**.
57-
You modify code, and your app updates in real-time.
58-
59-
3. **Inherent Security by Design**:
60-
By prioritizing direct DOM API manipulation over string-based methods (like `innerHTML`), Neo.mjs fundamentally reduces
61-
the attack surface for vulnerabilities like Cross-Site Scripting (XSS), building a more robust and secure application from the ground up.
62-
63-
4. **Declarative, Consistent, & Reusable Architecture**:
64-
Neo.mjs's unique **unified class config system** allows you to define components, layouts, and logic in a clean, declarative,
65-
and highly consistent way. This significantly reduces boilerplate, improves maintainability, and makes complex UI composition surprisingly straightforward.
66-
67-
5. **Scalability for Enterprise & Beyond**:
68-
Whether building sophisticated enterprise dashboards, data-intensive Gen AI interfaces, or desktop-like multi-window applications,
69-
Neo.mjs's modular, worker-driven architecture effortlessly scales. Components are persistent, stateful instances that can be unmounted,
70-
moved, and even remounted across browser windows without losing their logic or state. This is key to preventing the "re-rendering madness"
71-
common in other frameworks.
39+
## 🚀 The AI-Native Development Platform
40+
41+
Neo.mjs v11 introduces a revolutionary approach to software development: **Context Engineering**. We've moved beyond simple "AI-assisted" coding to create a truly **AI-native** platform where AI agents are deeply integrated partners in the development process. This is made possible by three dedicated **Model Context Protocol (MCP) servers** that give agents the context they need to understand, build, and reason about your code.
42+
43+
This isn't just about generating code; it's about creating a self-aware development environment that accelerates velocity, improves quality, and enables a new level of human-AI collaboration.
44+
45+
<p align="center">
46+
<img width="800px" src="https://raw.githubusercontent.com/neomjs/pages/master/resources_pub/website/blog/ContextEngineering.png" alt="Context Engineering Done Right" class="blog-image">
47+
</p>
48+
49+
1. **🧠 The Knowledge Base Server**: Gives agents a deep, semantic understanding of your project. Powered by ChromaDB and Gemini embeddings, it allows agents to perform semantic searches across your entire codebase, documentation, and historical tickets. An agent can ask, "How does VDOM diffing work?" and get the exact source files and architectural guides relevant to the *currently checked-out version*.
50+
51+
2. **💾 The Memory Core Server**: Provides agents with persistent, long-term memory. Every interaction—prompt, thought process, and response—is stored, allowing the agent to learn from experience, recall past decisions, and maintain context across multiple sessions. This transforms the agent from a stateless tool into a true collaborator that grows with your project.
52+
53+
3. **🤖 The GitHub Workflow Server**: Closes the loop by enabling agents to participate directly in your project's lifecycle. It provides tools for autonomous PR reviews, issue management, and bi-directional synchronization of GitHub issues into a local, queryable set of markdown files. This removes the human bottleneck in code review and project management.
54+
55+
This powerful tooling, co-created with AI agents, resulted in **resolving 388 tickets in just 6 weeks**. To learn more about this paradigm shift, read our blog post: **[388 Tickets in 6 Weeks: Context Engineering Done Right](./learn/blog/context-engineering-done-right.md)**.
7256

7357
</br></br>
74-
## 🚀 A New Era of Frontend Architecture
58+
## 💡 Why Choose Neo.mjs?
59+
60+
Traditional single-threaded frameworks struggle with performance bottlenecks, especially in large-scale, data-intensive applications. Neo.mjs offers a fundamentally different solution, designed for **uncompromising performance, AI-native productivity, and superior developer experience.**
61+
62+
1. **Eliminate UI Freezes with True Multithreading**:
63+
> *"The browser's main thread should be treated like a neurosurgeon: only perform precise, scheduled operations with zero distractions."*</br></br>
64+
— Neo.mjs Core Philosophy
65+
66+
Neo.mjs's OMT architecture inherently prevents UI freezes. With our optimized rendering pipeline, your UI will remain consistently responsive, even during intense data processing. It achieves an astonishing rate of **over 40,000 delta updates per second** in optimized environments, potential, limited only by user interaction, not the platform.
7567

76-
The v10 release marks a significant evolution of the Neo.mjs core, introducing a new functional component model and a revolutionary two-tier reactivity system. We've rebuilt the engine to provide an even more powerful and intuitive developer experience, making it simpler than ever to build complex, performant applications.
68+
2. **Unprecedented Velocity with an AI-Native Workflow**:
69+
The integrated MCP servers provide a "context-rich" environment where AI agents can work alongside human developers. This enables autonomous code reviews, deep codebase analysis, and a shared understanding of project history, dramatically accelerating development and solving the "bus factor" problem for complex projects.
7770

78-
To understand the depth of these changes and the philosophy behind them, we've published a five-part blog series that dives deep into the architecture of v10:
71+
3. **Build Desktop-Class, Multi-Window Applications**:
72+
Neo.mjs is the premier solution for building complex, multi-window web applications like **trading platforms, browser-based IDEs, Outlook-style email clients, and multi-screen LLM interfaces**. Its shared worker architecture allows a single application instance to run across multiple browser windows, with real-time state synchronization and the ability to move components between windows seamlessly.
73+
74+
4. **Unmatched Developer Experience: Transpilation-Free ESM**:
75+
Say goodbye to complex build steps. Neo.mjs apps run **natively as ES Modules directly in the browser**. This means **zero builds or transpilation** in dev mode, offering instant reloads and an unparalleled debugging experience where what you write is what you debug.
76+
77+
5. **Inherent Security by Design**:
78+
By prioritizing direct DOM API manipulation over string-based methods (like `innerHTML`), Neo.mjs fundamentally reduces the attack surface for vulnerabilities like Cross-Site Scripting (XSS), building a more robust and secure application from the ground up.
79+
80+
</br></br>
81+
## 📚 Foundational Architecture: The Core Principles
82+
83+
The v10 release marked a significant evolution of the Neo.mjs core, introducing a new functional component model and a revolutionary two-tier reactivity system. These principles form the bedrock of the framework today. We've published a five-part blog series that dives deep into this architecture:
7984

8085
1. **[A Frontend Love Story: Why the Strategies of Today Won't Build the Apps of Tomorrow](./learn/blog/v10-post1-love-story.md)**
8186
* *An introduction to the core problems in modern frontend development and the architectural vision of Neo.mjs.*
@@ -97,6 +102,22 @@ like a full calendar, carousels, and chart wrappers. All components are pre-buil
97102
multi-threaded architecture, significantly accelerating development and eliminating the complexity of integrating disparate
98103
external component libraries.
99104
</br></br>
105+
## A Platform at Scale: More Than Just a Library
106+
107+
To appreciate the scope of Neo.mjs, it's important to understand its scale. This is not a micro-library; it's a comprehensive, enterprise-ready platform representing over a decade of architectural investment. **Neo.mjs is an innovation factory.**
108+
109+
The stats below, from **October 2025**, provide a snapshot of the ecosystem. For a deeper dive, you can explore the full **[Codebase Overview](./learn/guides/fundamentals/CodebaseOverview.md)**.
110+
111+
- **~41,000 lines** of core platform source code
112+
- **~33,000 lines** across hundreds of working examples and flagship applications
113+
- **~11,000 lines** of production-grade theming
114+
- **~6,000 lines** of dedicated AI-native infrastructure
115+
- **~30,000 lines** of detailed JSDoc documentation
116+
117+
**Total: Over 130,000 lines of curated code and documentation.**
118+
119+
This is not a small library—it's a complete ecosystem with more source code than many established frameworks, designed for the most demanding use cases.
120+
</br></br>
100121
## 📊 Real-World Win: Crushing UI Lag in Action
101122

102123
Imagine a developer building a stock trading app with live feeds updating every millisecond. Traditional frameworks often choke,
@@ -130,17 +151,11 @@ That’s Neo.mjs in action — solving problems others can’t touch.
130151
from UI components for easier maintenance, testing, and team collaboration.
131152

132153
* **Multi-Window & Single-Page Applications (SPAs)***: Beyond traditional SPAs, Neo.mjs excels at complex multi-window applications.
133-
Its unique architecture, powered by seamless cross-worker communication (enabled by `Neo.worker.mixin.RemoteMethodAccess`) and
134-
extensible Main Thread addons (`Neo.main.addon.*`), enables truly native-like, persistent experiences across browser windows,
135-
all without a native shell. This is made possible by the same efficient delta-based DOM update engine, which can surgically
136-
move and update components across window boundaries with unparalleled performance.
154+
Its unique architecture, powered by seamless cross-worker communication and extensible Main Thread addons, enables truly native-like, persistent experiences across browser windows.
137155

138156
* **No npm Dependency Hell**: Neo.mjs apps run with **zero runtime dependencies**, just a few dev dependencies for tooling.
139157
This means smaller bundles, fewer conflicts, and a simpler dependency graph.
140158

141-
* **Cutting-Edge Use Cases**: Ideal for **data-intensive applications, real-time dashboards, web-based IDEs, banking
142-
applications, and complex multi-window Gen AI interfaces** where performance and responsiveness are non-negotiable.
143-
144159
* **Unparalleled Debugging Experience**: Benefit from Neo.mjs's built-in debugging capabilities. Easily inspect the full component
145160
tree across workers, live-modify component configurations directly in the browser console, and observe real-time UI updates,
146161
all without complex tooling setup.
@@ -149,8 +164,6 @@ That’s Neo.mjs in action — solving problems others can’t touch.
149164

150165
* **Async-Aware Component Lifecycle**: With the `initAsync()` lifecycle method, components can handle asynchronous setup (like fetching data or lazy-loading modules) *before* they are considered "ready." This eliminates entire classes of race conditions and UI flicker, allowing you to build complex, data-dependent components with confidence.
151166

152-
* **AI-Native through Context Engineering**: We are pioneering **Context Engineering** to build the first framework architected to be developed *with* AI agents. Instead of just prompting, we are building a dynamic system to provide our AI partner with the right knowledge and tools at the right time. This includes a rich, queryable knowledge base and clear guidelines for both the [AI](./.github/AGENTS.md) and the [human developer](./.github/WORKING_WITH_AGENTS.md). This architectural discipline not only enables AI partnership but also results in a cleaner, more predictable, and more maintainable codebase. Get started with the **[AI Knowledge Base Quick Start Guide](./.github/AI_QUICK_START.md)**.
153-
154167
<p align="center">
155168
<img src="./resources/images/workers-focus.svg" alt="Neo.mjs Worker Architecture Diagram - Shows Main Thread, App Worker, VDom Worker, Canvas Worker, Data Worker, Service Worker, Backend connections.">
156169
</p>
@@ -168,9 +181,10 @@ The true power of Neo.mjs lies in its foundational architectural choices, which
168181
| **Component Lifecycle** | **Stable & Persistent**: Instances are created once and persist through UI changes. Features a rich lifecycle with `construct`, `initAsync`, and `afterSetMounted`. | **React**: Ephemeral (functional components are re-executed on every render). **Vue/Angular**: More stable, but lack pre-ready async hooks for complex setup. | **Robust & Predictable**. `initAsync` solves async setup (data fetching, module loading) *before* the first render, preventing UI flicker. Persistence enables complex stateful apps and multi-window operations. |
169182
| **State Management** | **Surgical Subscriptions**: The integrated `StateProvider` allows components to subscribe *only* to the precise state slices they need, completely bypassing intermediate components. | **React**: Context API re-renders all consumers by default, requiring manual optimization. **Vue/Angular**: Optimized state managers (Pinia, NgRx) are still bound by the main thread. | **Scalable & Decoupled**. More performant for global state changes by default. Architecturally cleaner, avoiding props drilling and the performance traps of React's Context. |
170183
| **DOM Updates** | **Asymmetric & Off-Thread**: Simple, serializable JSON objects (blueprints) are sent to the VDOM worker for diffing. The Main Thread only receives and applies minimal, pre-calculated patches. | VDOM diffing and DOM manipulation are computationally expensive tasks that occur on the main thread, directly competing with user interactions. | **Faster, More Secure, and AI-Friendly**. Off-thread diffing is faster. Using direct DOM APIs instead of `innerHTML` is more secure. Simple JSON blueprints are trivial for AI to generate and manipulate. |
184+
| **AI & Dev Tooling** | **Integrated AI-Native Platform**: Three dedicated MCP servers provide context engineering, semantic search, agent memory, and autonomous workflow automation. | **Disconnected Tooling**: Relies on external, disconnected tools (linters, IDE extensions, CI scripts). No built-in context awareness for AI agents. | **Unprecedented Developer Velocity**. Enables true human-AI collaboration, autonomous code review, and a self-aware development environment that solves the "bus factor" problem. |
171185
| **Dev Experience** | **Zero-Builds Development**: Native ES Modules run directly in the browser. No transpilation or bundling is needed for development. | **Build-Heavy**: Relies on tools like Vite, Webpack, or the Angular CLI, which add complexity, require source maps, and introduce delays. | **Unparalleled Simplicity & Debugging Clarity**. What you write is what you debug. Instant feedback and the absence of complex build toolchains lead to a faster, more intuitive workflow. |
172186

173-
**The Bottom Line**: Where other frameworks optimize operations on the main thread, Neo.mjs moves them off the main thread entirely. This fundamental difference results in a framework that is not just faster, but architecturally more scalable, robust, and resilient to complexity.
187+
**The Bottom Line**: Where other frameworks optimize operations on the main thread, Neo.mjs moves them off the main thread entirely. This fundamental difference results in a platform that is not just faster, but architecturally more scalable, robust, and resilient to complexity.
174188

175189
</br></br>
176190
## ⚙️ Declarative Class Configuration: Build Faster, Maintain Easier
@@ -246,6 +260,7 @@ Next steps:
246260
* Many more are included inside the repos [apps](https://github.com/neomjs/neo/tree/dev/apps)
247261
& [examples](https://github.com/neomjs/neo/tree/dev/examples) folders.
248262
* :blue_book: All Blog Posts are listed here: [Neo.mjs Blog](https://neomjs.com/dist/production/apps/portal/#/blog)
263+
* :robot: Get started with the **[AI Knowledge Base Quick Start Guide](./.github/AI_QUICK_START.md)**.
249264

250265
</br></br>
251266
## 🧭 Vision & Roadmap

0 commit comments

Comments
 (0)