|
1 | | -"# nullreact" |
| 1 | +Here’s a **clean, world-class `README.md`** you can copy-paste directly: |
| 2 | + |
| 3 | +````md |
| 4 | +# nullReact |
| 5 | + |
| 6 | +> ZeroRuntime, CompilerFirst reactive engine for the web. |
| 7 | +> FineGrained reactivity, ExtremeSpeed, and `<1KB` runtime. |
| 8 | + |
| 9 | +--- |
| 10 | + |
| 11 | +nullReact is a blazing-fast alternative to traditional React frameworks. Built from scratch in Rust, it compiles JSX to zero-runtime JavaScript with fine-grained reactivity and signal-based updates — all in under 1KB of runtime. |
| 12 | + |
| 13 | +## ✨ Features |
| 14 | + |
| 15 | +- ⚡ **Compiler-First**: Converts JSX directly to reactive JavaScript. |
| 16 | +- 🔁 **Signals + Effects**: Built-in fine-grained reactivity system. |
| 17 | +- 🧠 **No Virtual DOM**: Direct DOM updates for extreme performance. |
| 18 | +- 📦 **<1KB Runtime**: Includes a minimal runtime shipped separately. |
| 19 | +- 🛠️ **Written in Rust**: Built for speed and safety. |
| 20 | + |
| 21 | +## 🚀 Quick Start |
| 22 | + |
| 23 | +```bash |
| 24 | +# Clone and build |
| 25 | +git clone https://github.com/pavanscales/nullreact |
| 26 | +cd nullreact |
| 27 | +make build |
| 28 | + |
| 29 | +# Run benchmark |
| 30 | +make bench |
| 31 | +```` |
| 32 | + |
| 33 | +## 🧪 Examples |
| 34 | + |
| 35 | +```jsx |
| 36 | +examples/1m-signals.jsx // 1 Million Signals, outperforms React |
| 37 | +examples/10k-filter.jsx // 10,000-item filtering demo |
| 38 | +``` |
| 39 | + |
| 40 | +## 📁 Folder Structure |
| 41 | + |
| 42 | +``` |
| 43 | +nullreact/ |
| 44 | +├── src/ |
| 45 | +│ ├── lib.rs # CLI + Compiler entry |
| 46 | +│ ├── jsx.rs # JSX → AST |
| 47 | +│ ├── emitter.rs # AST → Optimized JS |
| 48 | +│ ├── signals.rs # Signals and Effects system |
| 49 | +│ ├── runtime.js # DOM runtime |
| 50 | +│ └── bench.rs # Performance tests |
| 51 | +├── dist/ # Emitted JS output |
| 52 | +│ └── runtime.js # Runtime for importing |
| 53 | +├── examples/ # JSX usage demos |
| 54 | +├── Makefile # Build, test, benchmark |
| 55 | +├── README.md # You are here |
| 56 | +├── LICENSE # MIT License |
| 57 | +└── .gitignore # Clean ignored files |
| 58 | +``` |
| 59 | + |
| 60 | +## 💡 Philosophy |
| 61 | + |
| 62 | +* Reactivity should be **compiled**, not interpreted. |
| 63 | +* Runtime should be **opt-in**, not bloated. |
| 64 | +* Performance should be **measurable**, not theoretical. |
| 65 | + |
| 66 | +## 📜 License |
| 67 | + |
| 68 | +MIT © [Pawan Pediredla](mailto:pawanpediredla) |
| 69 | + |
| 70 | +GitHub: [@pavanscales](https://github.com/pavanscales) |
| 71 | + |
| 72 | +``` |
| 73 | +
|
| 74 | +Let me know if you want badges, logo, or GitHub Actions status added to it, brother. |
| 75 | +``` |
0 commit comments