lustre-labs · hayleigh-dot-dev · Dec 23, 2024 · Dec 23, 2024 · Dec 23, 2024 · Dec 23, 2024
diff --git a/.gitignore b/.gitignore
@@ -3,5 +3,11 @@
 build
 erl_crash.dump
 node_modules
-example/index.html
-example/priv
+
+src/lustre_ui.css
+
+priv/static/lustre_ui_storybook.*
+
+#Added automatically by Lustre Dev Tools
+/.lustre
+/dist
diff --git a/README.md b/README.md
@@ -72,6 +72,24 @@ gleam add lustre_ui@1.0.0-rc.1
 Ensure the required CSS is rendered in your apps by serving the stylesheet found
 in the `priv/static` directory of this package!
 
+## Usage
+
+In order for lustre/ui to work correctly you need to do two things:
+
+1. Include the lustre/ui stylesheet in your app. This can be found in the
+   `priv/static` directory for _this package_ and can either be served by your
+   backend (in case of a full stack application) or copied or otherwise included
+   from `build/packages/lustre_ui/priv/static` in your frontend application.
+
+2. Construct a theme from the `lustre/ui/theme` module and render the dynamic
+   style element by calling `theme.to_style` or wrapping your application's view
+   function using `theme.inject`.
+
+**Both** of these steps must be done in order for the components to render
+correctly. The base stylesheet includes the necessary CSS rules and classes for
+every component, and your theme defines the design tokens and CSS variables used
+by those components.
+
 ## Support
 
 Lustre is mostly built by just me, [Hayleigh](https://github.com/hayleigh-dot-dev),

diff --git a/assets/diagram-alert.svg b/assets/diagram-alert.svg
diff --git a/birdie_snapshots/tween_in_back.accepted b/birdie_snapshots/tween_in_back.accepted
diff --git a/birdie_snapshots/tween_in_bounce.accepted b/birdie_snapshots/tween_in_bounce.accepted
diff --git a/birdie_snapshots/tween_in_circ.accepted b/birdie_snapshots/tween_in_circ.accepted
diff --git a/birdie_snapshots/tween_in_cubic.accepted b/birdie_snapshots/tween_in_cubic.accepted
diff --git a/birdie_snapshots/tween_in_elastic.accepted b/birdie_snapshots/tween_in_elastic.accepted
diff --git a/birdie_snapshots/tween_in_expo.accepted b/birdie_snapshots/tween_in_expo.accepted
diff --git a/birdie_snapshots/tween_in_out_back.accepted b/birdie_snapshots/tween_in_out_back.accepted
diff --git a/birdie_snapshots/tween_in_out_bounce.accepted b/birdie_snapshots/tween_in_out_bounce.accepted