essor 0.0.15-beta.8 → 0.0.16-beta.1

package/README.md

@@ -1,27 +1,136 @@
-# @estjs/core
+# Essor - Next Generation Frontend Framework
 
-The core runtime for the **Essor** framework. It provides the application initialization logic and integrates the reactivity system with the rendering engine.
+<div align="center">
 
-## Installation
+![Essor Logo](logo.svg)
+
+**🚀 It's just JavaScript - Instant start, ultimate performance, no complex concepts**
+
+[![npm version](https://img.shields.io/npm/v/essor.svg)](https://www.npmjs.com/package/essor)
+[![npm downloads](https://img.shields.io/npm/dm/essor.svg)](https://www.npmjs.com/package/essor)
+[![GitHub license](https://img.shields.io/github/license/estjs/essor.svg)](https://github.com/estjs/essor/blob/main/LICENSE)
+[![GitHub issues](https://img.shields.io/github/issues/estjs/essor.svg)](https://github.com/estjs/essor/issues)
+![codecov](https://img.shields.io/codecov/c/github/estjs/essor)
+![ci](https://img.shields.io/github/actions/workflow/status/estjs/essor/ci.yml?label=CI&logo=GitHub)
+
+English | [简体中文](./README_CN.md)
+
+</div>
+
+## ✨ Features
+
+- 🚀 **Ultimate Performance** - Signal-based reactive system, no virtual DOM
+- 🎯 **Zero Config** - Works out of the box, no complex configuration
+- 🔧 **TypeScript** - Full TypeScript support
+- 🎨 **JSX Support** - Familiar JSX syntax, easy to learn
+- 📦 **Modular** - Tree-shakable, tiny bundle size
+- 🌐 **SSR/SSG** - Server-side rendering and static site generation support
+- 🔄 **HMR** - Hot module replacement, excellent development experience
+- 🛠️ **Toolchain** - Complete build toolchain support
+
+
+## 🚀 Quick Start
+
+### 1. Create Project
 
 ```bash
+# Using create-essor
+npm create essor@latest my-app
+
+# Or install manually
 npm install essor
 ```
 
-## Usage
+### 2. Write Component
 
-```tsx
-import { createApp, signal } from 'essor';
+```jsx
+import { signal } from 'essor';
 
-function App() {
+function Counter() {
   const count = signal(0);
-  return <button onclick={() => count.value++}>{count.value}</button>;
+
+  return (
+    <div>
+      <h1>Count: {count}</h1>
+      <button onClick={() => count.value++}>
+        Increment
+      </button>
+    </div>
+  );
 }
+```
+
+### 3. Start Development Server
 
-createApp(App, document.body);
+```bash
+npm run dev
 ```
 
+## 📚 Documentation
+
+- [Documentation](https://essor.netlify.app/)
+- [API Reference](https://essor.netlify.app/api)
+- [Examples](./examples)
+- [Online Playground](https://essor-playground.netlify.app/)
+
+## 🎯 Examples
+
+Check out the [examples](./examples) directory for more examples:
+
+- [Signals](./examples/signals) - Signal state, computed outputs, and batch updates
+- [TodoMVC](./examples/todo-mvc) - Basic todo flows
+- [Fragment](./examples/fragment) - Wrapper-free table rows
+- [Binding](./examples/binding) - Bind API across text, select, range, and files
+- [Provide](./examples/provide) - Scoped dependency injection
+- [Portal](./examples/portal) - Portal target switching and inline fallback
+- [Suspense](./examples/suspense) - Async boundaries with loading fallbacks
+- [HMR](./examples/hmr) - Stateful hot-refresh demo
+- [Hydrate](./examples/hydrate) - SSR shell and client hydration
+
+
+## 🤝 Contributing
+
+We welcome all forms of contributions!
+
+- 🐛 [Report Bugs](https://github.com/estjs/essor/issues)
+- 💡 [Suggest Features](https://github.com/estjs/essor/discussions)
+- 📝 [Submit PRs](https://github.com/estjs/essor/pulls)
+- 📚 [Improve Documentation](https://github.com/estjs/essor/tree/main/docs)
+
+### Development Setup
+
+```bash
+# Clone repository
+git clone https://github.com/estjs/essor.git
+cd essor
+
+# Install dependencies
+pnpm install
+
+# Start development mode
+pnpm dev
+
+# Run tests
+pnpm test
+
+# Build project
+pnpm build
+```
+
+## 📄 License
+
+[MIT License](./LICENSE)
+
+## 🙏 Acknowledgments
+
+Thanks to all developers who contributed to Essor!
+
+---
+
+<div align="center">
+
+**If this project helps you, please give us a ⭐️**
 
-## License
+[GitHub](https://github.com/estjs/essor) | [Documentation](https://essor.netlify.app/) | [Discussions](https://github.com/estjs/essor/discussions)
 
-MIT
+</div>