Skip to content

Commit ccace9c

Browse files
committed
added readme.md
1 parent d630738 commit ccace9c

File tree

2 files changed

+157
-1
lines changed

2 files changed

+157
-1
lines changed

.gitignore

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# === Rust ===
2+
/target/
3+
**/*.rs.bk
4+
Cargo.lock
5+
*.rlib
6+
*.dSYM/
7+
8+
# === JavaScript / TypeScript ===
9+
node_modules/
10+
dist/
11+
build/
12+
*.log
13+
*.tsbuildinfo
14+
npm-debug.log*
15+
yarn-debug.log*
16+
yarn-error.log*
17+
18+
# === Bun / Deno (if used) ===
19+
.bun/
20+
deno.lock
21+
deno_dir/
22+
23+
# === Environment Files ===
24+
.env
25+
.env.*.local
26+
.env.local
27+
.env.development.local
28+
.env.test.local
29+
.env.production.local
30+
31+
# === Editor / IDE ===
32+
.vscode/
33+
.idea/
34+
*.code-workspace
35+
*.sublime*
36+
*.sw?
37+
38+
# === OS / System Files ===
39+
.DS_Store
40+
Thumbs.db
41+
ehthumbs.db
42+
Icon?
43+
44+
# === Coverage / Reports ===
45+
coverage/
46+
*.lcov
47+
.nyc_output/
48+
test-results/
49+
reports/
50+
51+
# === Binary / Output / Debug ===
52+
*.out
53+
*.exe
54+
*.obj
55+
*.dll
56+
*.class
57+
*.wasm
58+
*.map
59+
60+
# === Logs / Temp / Cache ===
61+
*.tmp
62+
*.temp
63+
.cache/
64+
.pnp.*
65+
*.log
66+
*.pid
67+
*.seed
68+
69+
# === Git ===
70+
*.orig
71+
*.rej
72+
*.patch
73+
*.bak
74+
75+
# === Benchmarks ===
76+
/benches/*.log
77+
/tests/output/
78+
79+
# === Custom ===
80+
/docs/gen/
81+
*.iml
82+
*.lock-wip

README.md

Lines changed: 75 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,75 @@
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

Comments
 (0)