diff --git a/README.md b/README.md index e924b50..c8fb200 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,9 @@ # Regor -Regor is a powerful UI framework designed to streamline the development of HTML5-based applications for both web and desktop environments. With a template syntax that closely follows Vue.js, transitioning from VueJS to Regor is seamless for developers familiar with Vue. +Regor is a runtime-first UI framework for teams that want direct DOM control, strong TypeScript ergonomics, and precise reactivity behavior without being forced into a Virtual DOM architecture. + +Its template syntax is familiar to Vue users (`r-if`, `r-model`, `r-for`, `r-bind`), but its runtime model is intentionally different: Regor is built for progressive enhancement, mixed-rendering environments, and incremental adoption. ### [![Published on npm](https://img.shields.io/npm/v/regor.svg)](https://www.npmjs.com/package/regor) @@ -10,9 +12,9 @@ Regor is a powerful UI framework designed to streamline the development of HTML5 ## Key Features -- **Simplicity:** Develop UIs without a Virtual DOM for a more straightforward implementation and easier debugging. -- **TypeScript:** Enjoy native TypeScript support without workarounds. -- **No Build Step Required:** Define components in TypeScript using tagged string templates, no build step needed. +- **No VDOM Layer:** Bind directly to real DOM for transparent runtime behavior and straightforward debugging. +- **TypeScript-Native:** Use standard TypeScript interfaces, classes, and generics without framework-specific file formats. +- **No Build Step Required:** Define components in TypeScript using tagged string templates with npm, CDN ESM, or global build workflows. - **Secure Evaluation:** Regor's secure JavaScript VM ensures safe runtime compilation. You can enable security policy in your page without removing runtime compilation support. ```html @@ -22,9 +24,9 @@ Regor is a powerful UI framework designed to streamline the development of HTML5 /> ``` -- **Flexible Reactivity:** Empowering developers with a highly flexible reactivity system. -- **Non-JS SSR:** Bind to the existing DOM without removing already mounted HTML elements, suitable for non-JavaScript server-side rendering. -- **Reentrance:** Regor supports multiple mountings in the previously mounted area using the same or different app contexts. This enables creating and mounting new directives dynamically. +- **Flexible Reactivity:** Combine `ref`, `sref`, `batch`, `pause`, `resume`, and `entangle` for explicit state orchestration. +- **Static-First + Islands:** Bind to existing DOM without removing server-rendered HTML, ideal for progressive enhancement. +- **Reentrance:** Mount multiple times in already-mounted regions with same or different app contexts. - **Compatibility:** Rendered pages are designed for seamless integration with other libraries manipulating the DOM. ## Documentation @@ -72,16 +74,13 @@ const template = html`