sinwan 0.0.0 → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Mohammed Ben Cheikh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1 +1,67 @@
-# sinwan
+# Sinwan — Reactive UI Library
+
+A modern reactive UI library with SSR, hydration, and fine-grained reactivity.
+
+## Features
+
+- **Reactivity** — `signal()`, `computed()`, `effect()`, `batch()` with fine-grained tracking
+- **JSX** — Custom JSX runtime producing `SinwanElement` trees
+- **Components** — `createComponent()` with lifecycle hooks (`onMounted`, `onUnmounted`, `onUpdated`, `onError`)
+- **Renderer** — Client-side DOM renderer with reactive text, attributes, and event binding
+- **Provide/Inject** — Dependency injection across component trees
+- **SSR** — `renderToString()`, `streamPage()` for server-side rendering
+- **Hydration** — `hydrate()` to attach reactivity to server-rendered HTML without DOM recreation
+
+## Quick Start
+
+```tsx
+import { signal, createComponent, mount, onMounted } from "Sinwan";
+
+const Counter = createComponent<{ initial?: number }>(({ initial = 0 }) => {
+  const count = signal(initial);
+
+  onMounted(() => console.log("Counter mounted!"));
+
+  return (
+    <div>
+      <span>{count}</span>
+      <button onClick={() => count.value++}>+</button>
+    </div>
+  );
+});
+
+mount(Counter, document.getElementById("app")!);
+```
+
+## SSR + Hydration
+
+```tsx
+// Server
+import { renderToHydratableString } from "Sinwan/server";
+const html = await renderToHydratableString(Counter, { initial: 5 });
+
+// Client
+import { hydrate } from "Sinwan";
+hydrate(Counter, document.getElementById("app")!, { initial: 5 });
+```
+
+## Project Structure
+
+```
+src/
+├── types.ts              # Core types (SinwanNode, SinwanElement, etc.)
+├── escaper.ts            # HTML escaping
+├── jsx/                  # JSX runtime
+├── reactivity/           # signal, computed, effect, batch, scheduler
+├── component/            # createComponent, lifecycle, provide/inject
+├── renderer/             # Client DOM renderer (mount, render-element, etc.)
+├── hydration/            # Client hydration (hydrate, markers, walk)
+├── server/               # SSR (renderToString, stream, hydration-markers)
+└── index.ts              # Main barrel export
+```
+
+## Tests
+
+```bash
+bun test
+```