@odoo/owl 3.0.0-alpha.26 → 3.0.0-alpha.28

package/README.md

@@ -1,139 +0,0 @@
-<h1 align="center">🦉 <a href="https://odoo.github.io/owl/">Owl</a> 🦉</h1>
-
-<p align="center">
-  <strong>A modern, lightweight UI framework for applications that scale</strong>
-</p>
-
-[![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)
-[![npm version](https://badge.fury.io/js/@odoo%2Fowl.svg)](https://badge.fury.io/js/@odoo%2Fowl)
-[![Downloads](https://img.shields.io/npm/dm/@odoo%2Fowl.svg)](https://www.npmjs.com/package/@odoo/owl)
-
----
-
-> **Owl 3.0.0 Alpha:** This is an alpha release. The API and features are subject to change without notice.
-
----
-
-## Try it now
-
-The fastest way to discover Owl is the **[online playground](https://odoo.github.io/owl/playground)**.
-It features interactive examples, a live editor, and showcases all major features:
-reactivity, components, plugins, and more. It also includes **guided tutorials**
-and is the recommended way to learn about Owl.
-
-## What is Owl?
-
-Owl is a modern UI framework (~20kb gzipped, zero dependencies) written in TypeScript,
-built by [Odoo](https://www.odoo.com/). It powers Odoo's web client, one of the largest
-open-source business applications, but is equally suited for small projects and prototypes.
-
-Key features:
-
-- **Signal-based reactivity** — Explicit, composable, and debuggable state management
-- **Plugin system** — Type-safe, composable sharing of state and services
-- **Class-based components** — Familiar OOP patterns with ES6 classes
-- **Declarative templates** — XML templates with a clean syntax
-- **Async rendering** — Concurrent mode for smooth user experiences
-
-## Quick Example
-
-```javascript
-import { Component, signal, computed, mount, xml } from "@odoo/owl";
-
-class TodoList extends Component {
-  static template = xml`
-    <input placeholder="Add todo..." t-on-keydown="this.onKeydown"/>
-    <ul>
-      <t t-foreach="this.todos()" t-as="todo" t-key="todo.id">
-        <li t-att-class="{ done: todo.done }">
-          <input type="checkbox" t-model="todo.done"/>
-          <t t-out="todo.text"/>
-        </li>
-      </t>
-    </ul>
-    <p t-if="this.remaining() > 0">
-      <t t-out="this.remaining()"/> item(s) remaining
-    </p>`;
-
-  todos = signal.Array([
-    { id: 1, text: "Learn Owl", done: false },
-    { id: 2, text: "Build something", done: false },
-  ]);
-
-  remaining = computed(() => this.todos().filter((t) => !t.done).length);
-
-  onKeydown(ev) {
-    if (ev.key === "Enter" && ev.target.value) {
-      this.todos.push({
-        id: Date.now(),
-        text: ev.target.value,
-        done: false,
-      });
-      ev.target.value = "";
-    }
-  }
-}
-
-mount(TodoList, document.body);
-```
-
-This example demonstrates Owl's reactivity: `todos` is a signal, `remaining`
-is a computed value that updates automatically, and the UI reacts to changes
-without manual subscription management.
-
-## Documentation
-
-The documentation below is for **Owl 3**. For the Owl 2 documentation, see the
-[owl-2.x branch](https://github.com/odoo/owl/tree/owl-2.x).
-
-### Getting Started
-
-- **[Playground](https://odoo.github.io/owl/playground)** — Interactive examples and live coding
-- [Tutorial: Getting Started](https://odoo.github.io/owl/playground#getting_started) — Learn Owl fundamentals step by step
-- [Tutorial: Todo List](https://odoo.github.io/owl/playground#todo_list) — Build a full TodoMVC app
-- [Tutorial: Hibou OS](https://odoo.github.io/owl/playground#hibou_os) — Build a desktop-like interface
-
-### Reference
-
-- [API Reference](doc/readme.md) — A complete list of everything exported by the Owl library
-- [App](doc/reference/app.md) — Configure and mount an Owl application to the DOM
-- [Component](doc/reference/component.md) — Define components with lifecycle methods and static properties
-- [Error Handling](doc/reference/error_handling.md) — Catch and recover from errors in components
-- [Event Handling](doc/reference/event_handling.md) — Handle DOM events with t-on directives
-- [Form Bindings](doc/reference/form_bindings.md) — Bind form inputs to reactive state with t-model
-- [Hooks](doc/reference/hooks.md) — Use lifecycle hooks and other built-in hooks in components
-- [Plugins](doc/reference/plugins.md) — Share state and services across components with type-safe plugins
-- [Props](doc/reference/props.md) — Pass data to child components with validation and defaults
-- [Reactivity](doc/reference/reactivity.md) — Manage state with signals, computed values, and reactive objects
-- [Refs](doc/reference/refs.md) — Access DOM elements from components with t-ref
-- [Resources and Registries](doc/reference/resources_and_registries.md) — Ordered reactive collections for shared data
-- [Slots](doc/reference/slots.md) — Compose components with named and dynamic slot content
-- [Template Syntax](doc/reference/template_syntax.md) — Write XML templates with QWeb directives
-- [Translations](doc/reference/translations.md) — Translate templates and dynamic strings
-- [Types Validation](doc/reference/types_validation.md) — Validate data structures at runtime with a declarative schema
-
-### Misc
-
-- [Owl 3.x Release Notes](release_notes.md) — Complete guide to all changes in Owl 3
-- [Design Principles](doc/miscellaneous/design_principles.md)
-- [Why we built Owl](doc/miscellaneous/why_owl.md)
-- [Architecture Notes](doc/miscellaneous/architecture.md)
-- [Comparison with React/Vue](doc/miscellaneous/comparison.md)
-
-## Installation
-
-```bash
-npm install @odoo/owl
-```
-
-Or download directly: [latest release](https://github.com/odoo/owl/releases/latest)
-
-## Devtools
-
-The Owl devtools extension helps debug your applications with component tree
-inspection, state visualization, and performance profiling. Download it from
-the [releases page](https://github.com/odoo/owl/releases/latest).
-
-## License
-
-Owl is released under the [LGPL v3](https://www.gnu.org/licenses/lgpl-3.0) license.