From 9432c65fa4f5964674021a95bdeb6d0686771963 Mon Sep 17 00:00:00 2001
From: metacryst
Date: Tue, 3 Sep 2024 13:17:27 -0500
Subject: [PATCH] update readme
---
README.md | 35 ++++++++++++++++++++++++-----------
1 file changed, 24 insertions(+), 11 deletions(-)
diff --git a/README.md b/README.md
index 1b56bb4..8dae8b9 100644
--- a/README.md
+++ b/README.md
@@ -5,20 +5,33 @@
-Usage: Install the VSCode extension "Quill".
+Quill is a SwiftUI-style JavaScript framework. It makes use of components called Shadows, which are HTML Custom Elements.
-## Rendering Elements:
+### Getting Started:
+Go to https://github.com/capturedsun/template-quill and clone this repo.
+
+### App:
+src/app.js is the application entry point. Any Shadows rendered inside will be rendered in the body.
+
+### Rendering Elements:
+
+The basis of rendering is the Shadow, which extends HTMLElement. The Shadow is the equivalent of a React Component.
+
+To create a Shadow, simply:
+- Create a class which extends Shadow
+- Include a render() function
+- Register the shadow as an element
+
+...
```
-document.body.append(
- p("Hi")
- .padding("top", 12),
+class File extends Shadow {
+ render = () => {
+ p(this.name)
+ p("asd")
+ }
+}
- Link({href: "google.com", name: "hey"})
- .background("green")
-
- // NavigationBar()
- // .onClick()
-)
+register(File, "file-el")
```
## Needs Support: