Feat: include the helper

packages/core/README.md

@@ -1,22 +1,39 @@
 # Dioxus-core
 
-In the world of Rust UI + wasm UI toolkits, Dioxus is taking a fairly opinionated stance by being functional-only with hooks/context as the primary method of interacting with state.
+This is the core crate for the Dioxus Virtual DOM. This README will focus on the technical design and layout of this Virtual DOM implementation. If you want to read more about using Dioxus, then check out the Dioxus crate, documentation, and website.
 
-To focus on building an effective user experience, 
+## Internals
+Dioxus-core builds off the many frameworks that came before it. Notably, Dioxus borrows these concepts:
 
+- React: hooks, concurrency, suspense
+- Dodrio: bump allocation / custom faster allocators, stack machine for fast changes
+- Percy: html! macro implementation and agnostic edit list
+- Yew: passion and inspiration ❤️
 
+## Goals
 
+We have big goals for Dioxus. The final implementation must:
 
+- Be **fast**. Allocators are typically slow in WASM/Rust, so we should have a smart way of allocating.
+- Be concurrent. Components should be able to pause rendering using a threading mechanism.
+- Support "broadcasting". Edit lists should be separate from the Renderer implementation.
+- Support SSR. VNodes should render to a string that can be served via a web server.
+- Be "live". Components should be able to be both server rendered and client rendered without needing frontend APIs.
+- Be modular. Components and hooks should be work anywhere without worrying about target platform.
 
+## Optimizations
 
-Sources
----
-percy: https://github.com/chinedufn/percy/blob/master/crates/virtual-dom-rs/src/patch/mod.rs
-yew: 
-dodrio: 
-rsx:
+- Support a pluggable allocation strategy that makes VNode creation **very** fast
+- Support lazy DomTrees (ie DomTrees that are not actually created when the view fn is ran)
+- Support advanced diffing strategies
 
-react:
-fre:
+## Design Quirks
 
+- Use of "Context" as a way of mitigating threading issues and the borrow checker. (JS relies on globals)
+- html! is lazy - needs to be used with a partner function to actually allocate the html.
+
+```rust
+let text = TextRenderer::render(html! {<div>"hello world"</div>});
+// <div>hello world</div>
+```