proscenium 0.9.1-x86_64-linux → 0.11.0.pre.1-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71a12abb51c6bceb8d9967c2c4421273cd1bc80b2d775aa67e72602dfae82cf3
-  data.tar.gz: 2ce2a87ee29c7c74cb5a50e1e1281ef450a811a8e2b088b99a58c7c2476c733b
+  metadata.gz: 80efacad8425cf4168501954ad90dc4329ef6989b9ca583403070719e734f93b
+  data.tar.gz: 726aa7aaa0a4b169c90f9ad1b014afc9ac39aeb9c56a93d7f3b75e8adeb69198
 SHA512:
-  metadata.gz: fcdeaf64d5ae076567bf4b0bc48f8c2ec5aace968fdeae919a1761a3a6017bbbb80790b9ad2d638b282517190f01077d4f53f05ce69830860f4dd47755a8f74a
-  data.tar.gz: 89da9f60cb2db25668fc3ca980de9e7cf3f98d45755070ccbac8d03e88a83d7e058f0a2888159b9aa5d3b14536954212921eb8d64e368cf897db12895dd4fc2c
+  metadata.gz: f90b3f793838132104e3b9b563f8299facf614af5dd40b66fdde367314f60450ed852607d1ec06176ee852679d9183a7bf9ab23cf6c6ecadff80450391ee14a9
+  data.tar.gz: 1a8d955df5a5c129793a4b02792756a2c5ca2c6073633b6c5fb71ed43af3abac7881ded5413d75ce3b1537a3920c2219bce1e32b78cd9d4b1d74f70073be66ff

data/README.md

@@ -1,31 +1,65 @@
 # Proscenium - Modern client-side development for Rails
 
-Proscenium treats your client-side code as first class citizens of your Rails app, and assumes a
-"fast by default" internet. It bundles your JS, JSX and CSS in real time, on demand, and with zero
-configuration.
+Proscenium treats your client-side code as first class citizens of your Rails app, and assumes a "fast by default" internet. It bundles your JavaScript and CSS in real time, on demand, and with zero configuration.
 
-- Fast real-time bundling, tree-shaking and minification.
-- Real time bundling of Javascript (.js,.jsx), Typescript (.ts,.tsx) and CSS (.css).
-- NO JavaScript runtime - just the browser!
+**The highlights:**
+
+- Fast real-time bundling, tree-shaking, code-splitting and minification of Javascript (.js,.jsx), Typescript (.ts,.tsx) and CSS (.css).
+- NO JavaScript runtime needed - just the browser!
 - NO build step or pre-compilation.
 - NO additional process or server - Just run Rails!
 - Deep integration with Rails.
-- Zero configuration.
-- Serve assets from anywhere within your Rails root (/app, /config, /lib, etc.).
-- Automatically side load JS/TS/CSS for your layouts and views.
-- Import from NPM, URLs, and locally.
+- Automatically side-load your layouts, views, and partials.
+- Import from NPM, URL's, and locally.
 - Server-side import map support.
-- CSS Modules.
-- CSS mixins.
+- CSS Modules & mixins.
 - Source maps.
-- Phlex and ViewComponent integration.
+
+## Table of Contents
+
+- [Getting Started](#getting-started)
+- [Installation](#installation)
+- [Client-Side Code Anywhere](#client-side-code-anywhere)
+- [Side Loading](#side-loading)
+- [Importing](#importing-assets)
+  - [URL Imports](#url-imports)
+  - [Local Imports](#local-imports)
+- [Import Maps](#import-maps)
+- [Source Maps](#source-maps)
+- [SVG](#svg)
+- [Environment Variables](#environment-variables)
+- [i18n](#i18n)
+- [JavaScript](#javascript)
+  - [Tree Shaking](#tree-shaking)
+  - [Code Splitting](#code-splitting)
+  - [JavaScript Caveats](#javascript-caveats)
+- [CSS](#css)
+  - [Importing CSS from JavaScript](#importing-css-from-javascript)
+  - [CSS Modules](#css-modules)
+  - [CSS Mixins](#css-mixins)
+  - [CSS Caveats](#css-caveats)
+- [Typescript](#typescript)
+  - [Typescript Caveats](#typescript-caveats)
+- [JSX](#jsx)
+- [JSON](#json)
+- [Phlex Support](#phlex-support)
+- [ViewComponent Support](#viewcomponent-support)
+- [Cache Busting](#cache-busting)
+- [rjs is back!](#rjs-is-back)
+- [Included Paths](#included-paths)
+- [Thanks](#thanks)
+- [Development](#development)
 
 ## Getting Started
 
-Getting started obviously depends on whether you are adding Proscenium to an existing Rails app, or creating a new Rails app. So please choose the appropriate guide below:
+Getting started obviously depends on whether you are adding Proscenium to an existing Rails app, or creating a new one. So choose the appropriate guide below:
 
 - [Getting Started with a new Rails app](https://github.com/joelmoss/proscenium/blob/master/docs/guides/new_rails_app.md)
-- Getting Started with an existing Rails app *[Coming soon]*
+- Getting Started with an existing Rails app
+  - [Migrate from Sprockets](docs/guides/migrate_from_sprockets.md)
+  - Migrate from Propshaft *[Coming soon]*
+  - Migrate from Webpacker *[Coming soon]*
+- [Render a React component with Proscenium](docs/guides/basic_react.md)
 
 ## Installation
 
@@ -53,48 +87,107 @@ Using the examples above...
 - `app/components/menu_component.jsx` => `https://yourapp.com/app/components/menu_component.jsx`
 - `config/properties.css` => `https://yourapp.com/config/properties.css`
 
-### Include Paths
+## Side Loading
 
-By default, Proscenium will serve files ending with any of these extension: `js,mjs,ts,css,jsx,tsx`, and only from `app/assets`, `config`, `app/views`, `lib` and `node_modules` directories.
+> Prior to **0.10.0**, only assets with the extension `.js`, `.ts` and `.css` were side loaded. From 0.10.0, all assets are side loaded, including `.jsx`, `.tsx`, and `.module.css`. Also partials were not side loaded prior to 0.10.0.
 
-However, you can customise these paths with the `include_path` config option...
+Proscenium is best experienced when you side load your assets.
 
-```ruby
-Rails.application.config.proscenium.include_paths << 'app/components'
+### The Problem
+
+With Rails you would typically declaratively load your JavaScript and CSS assets using the `javascript_include_tag` and `stylesheet_link_tag` helpers.
+
+For example, you may have top-level "application" CSS located in a file at `/app/assets/application.css`. Likewise, you may have some global JavaScript located in a file at `/app/assets/application.js`.
+
+You would manually and declaratively include those two files in your application layout, something like this:
+
+```erb
+<%# /app/views/layouts/application.html.erb %>
+
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Hello World</title>
+    <%= stylesheet_link_tag 'application' %> <!-- << Your app CSS -->
+  </head>
+  <body>
+    <%= yield %>
+    <%= javascript_include_tag 'application' %> <!-- << Your app JS -->
+  </body>
+</html>
 ```
 
-## Side Loading
+Now, you may have some CSS and JavaScript that is only required by a specific view and partial, so you would load that in your view (or layout), something like this:
 
-Proscenium has built in support for automatically side loading JS, TS and CSS with your views and
-layouts.
+```erb
+<%# /app/views/users/index.html.erb %>
 
-Just create a JS and/or CSS file with the same name as any view or layout, and make sure your
-layouts include `<%= side_load_stylesheets %>` and `<%= side_load_javascripts %>`. Something like
-this:
+<%= stylesheet_link_tag 'users' %>
+<%= javascript_include_tag 'users' %>
 
-```html
+<%# needed by the `users/_user.html.erb` partial %>
+<%= javascript_include_tag '_user' %>
+
+<% render @users %>
+```
+
+The main problem is that you have to keep track of all these assets, and make sure each is loaded by all the views that require them, but also avoid loading them when not needed. This can be a real pain, especially when you have a lot of views.
+
+### The Solution
+
+When side loading your JavaScript, Typescript and CSS with Proscenium, they are automatically included alongside your views, partials, layouts, and components, and only when needed.
+
+Side loading works by looking for a JS/TS/CSS file with the same name as your view, partial, layout or component. For example, if you have a view at `app/views/users/index.html.erb`, then Proscenium will look for a JS/TS/CSS file at `app/views/users/index.js`, `app/views/users/index.ts` or `app/views/users/index.css`. If it finds one, it will include it in the HTML for that view.
+
+JSX is also supported for JavaScript and Typescript. Simply use the `.jsx` or `.tsx` extension instead of `.js` or `.ts`.
+
+### Usage
+
+Simply create a JS and/or CSS file with the same name as any view, partial or layout.
+
+Let's continue with our problem example above, where we have the following assets
+
+- `/app/assets/application.css`
+- `/app/assets/application.js`
+- `/app/assets/users.css`
+- `/app/assets/users.js`
+- `/app/assets/user.js`
+
+Your application layout is at `/app/views/layouts/application.hml.erb`, and the view that needs the users assets is at `/app/views/users/index.html.erb`, so move your assets JS and CSS alongside them:
+
+- `/app/views/layouts/application.css`
+- `/app/views/layouts/application.js`
+- `/app/views/users/index.css`
+- `/app/views/users/index.js`
+- `/app/views/users/_user.js` (partial)
+
+Now, in your layout and view, replace the `javascript_include_tag` and `stylesheet_link_tag` helpers with the `include_stylesheets` and `include_javascripts` helpers from Proscenium. Something like this:
+
+```erb
 <!DOCTYPE html>
 <html>
   <head>
     <title>Hello World</title>
-    <%= side_load_stylesheets %>
+    <%= include_stylesheets %>
   </head>
   <body>
     <%= yield %>
-    <%= side_load_javascripts defer: true, type: 'module' %>
+    <%= include_javascripts type: 'module', defer: true %>
   </body>
 </html>
 ```
 
-On each page request, Proscenium will check if your layout and view has a JS/TS/CSS file of the same
-name, and include them into your layout HTML. Partials are not side loaded.
+> NOTE that Proscenium is desiged to work with modern JavaAscript, and assumes [ESModules](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) are used everywhere. This is why the `type` attribute is set to `module` in the example above. If you are not using ESModules, then you can omit the `type` attribute.
+
+On each page request, Proscenium will check if your views, layouts and partials have a JS/TS/CSS file of the same name, and then include them wherever your placed the `include_stylesheets` and `include_javascripts` helpers.
 
-Side loading is enabled by default, but you can disable it by setting `config.proscenium.side_load`
-to `false`.
+Now you never have to remember to include your assets again. Just create them alongside your views, partials and layouts, and Proscenium will take care of the rest.
 
-## Importing
+Side loading is enabled by default, but you can disable it by setting `config.proscenium.side_load` to `false` in your `/config/application.rb`.
 
-Proscenium supports importing JS, JSX, TS and CSS from NPM, by URL, your local app, and even from Ruby Gems.
+## Importing Assets
+
+Proscenium supports importing JS, JSX, TS, TSX, CSS and SVG from NPM, by URL, your local app, and even from Ruby Gems.
 
 Imported files are bundled together in real time. So no build step or pre-compilation is needed.
 
@@ -134,9 +227,13 @@ import utils from '/lib/utils'
 import constants from './constants'
 ```
 
-## Import Map [WIP]
+## Import Maps
+
+> **[WIP]**
+
+[Import maps](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script/type/importmap) for both JS and CSS is supported out of the box, and works with no regard to the browser being used. This is because the import map is parsed and resolved by Proscenium on the server, instead of by the browser. This is faster, and also allows you to use import maps in browsers that do not support them yet.
 
-[Import map](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script/type/importmap) for both JS and CSS is supported out of the box, and works with no regard to the browser being used. This is because the import map is parsed and resolved by Proscenium on the server. If you are not familiar with import maps, think of it as a way to define aliases.
+If you are not familiar with import maps, think of them as a way to define aliases.
 
 Just create `config/import_map.json` and specify the imports you want to use. For example:
 
@@ -166,7 +263,7 @@ and for CSS...
 @import '@radix-ui/colors/blue.css';
 ```
 
-You can also write your import map in Javascript instead of JSON. So instead of `config/import_map.json`, create `config/import_map.js`, and define an anonymous function. This function accepts a single `environment` argument.
+You can also write your import map in JavaScript instead of JSON. So instead of `config/import_map.json`, create `config/import_map.js`, and define an anonymous function. This function accepts a single `environment` argument.
 
 ```js
 env => ({
@@ -176,21 +273,89 @@ env => ({
 })
 ```
 
-## Importing SVG from JS(X) and TS(X)
+## Source Maps
+
+Source maps can make it easier to debug your code. They encode the information necessary to translate from a line/column offset in a generated output file back to a line/column offset in the corresponding original input file. This is useful if your generated code is sufficiently different from your original code (e.g. your original code is TypeScript or you enabled minification). This is also useful if you prefer looking at individual files in your browser's developer tools instead of one big bundled file.
+
+Source map output is supported for both JavaScript and CSS. Each file is appended with the link to the source map. For example:
+
+```js
+//# sourceMappingURL=/app/views/layouts/application.js.map
+```
 
-Importing SVG from JS(X) will bundle the SVG source code. Additionally, if importing from JSX or TSX, the SVG source code will be rendered as a JSX/TSX component.
+Your browsers dev tools should pick this up and automatically load the source map when and where needed.
+
+## SVG
+
+You can import SVG from JS(X), which will bundle the SVG source code. Additionally, if importing from JSX or TSX, the SVG source code will be rendered as a JSX/TSX component.
 
 ## Environment Variables
 
-Import any environment variables into your JS(X) code.
+> Available in `>=0.10.0`
+
+You can define and access any environment variable from your JavaScript and Typescript under the `proscenium.env` namespace.
+
+For performance and security reasons you must declare the environment variable names that you wish to expose in your `config/application.rb` file.
+
+```ruby
+config.proscenium.env_vars = Set['API_KEY', 'SOME_SECRET_VARIABLE']
+config.proscenium.env_vars << 'ANOTHER_API_KEY'
+```
+
+This assumes that the environment variable of the same name has already been defined. If not, you will need to define it yourself either in your code using Ruby's `ENV` object, or in your shell.
+
+These declared environment variables will be replaced with constant expressions, allowing you to use this like this:
+
+```js
+console.log(proscenium.env.RAILS_ENV) // console.log("development")
+console.log(proscenium.env.RAILS_ENV === 'development') // console.log(true)
+```
+
+The `RAILS_ENV` and `NODE_ENV` environment variables will always automatically be declared for you.
+
+In addition to this, Proscenium also provides a `process.env.NODE_ENV` variable, which is set to the same value as `proscenium.env.RAILS_ENV`. It is provided to support the community's existing tooling, which often relies on this variable.
+
+Environment variables are particularly powerful in aiding [tree shaking](#tree-shaking).
+
+```js
+function start() {
+  console.log("start")
+}
+function doSomethingDangerous() {
+  console.log("resetDatabase")
+}
+
+proscenium.env.RAILS_ENV === "development" && doSomethingDangerous()
+
+start()
+```
+
+In development the above code will be transformed into the following code, discarding the definition, and call to`doSomethingDangerous()`.
 
 ```js
-import RAILS_ENV from '@proscenium/env/RAILS_ENV'
+function start() {
+  console.log("start")
+}
+start()
+```
+
+Please note that for security reasons environment variables are not replaced in URL imports.
+
+An undefined environment variable will be replaced with `undefined`.
+
+```js
+console.log(proscenium.env.UNKNOWN) // console.log((void 0).UNKNOWN)
 ```
 
-You can only access environment variables that are explicitly named. It will export `undefined` if the env variable does not exist.
+This means that code that relies on this will not be tree shaken. You can work around this by using the [optional chaining operator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Optional_chaining):
 
-## Importing i18n
+```js
+if (typeof proscenium.env?.UNKNOWN !== "undefined") {
+  // do something if UNKNOWN is defined
+}
+```
+
+## i18n
 
 Basic support is provided for importing your Rails locale files from `config/locales/*.yml`, exporting them as JSON.
 
@@ -226,6 +391,48 @@ function one() {
 one();
 ```
 
+### Code Splitting
+
+> Available in `>=0.10.0`.
+
+[Side loaded](#side-loading) assets are automatically code split. This means that if you have a file that is imported and used imported several times, and by different files, it will be split off into a separate file.
+
+As an example:
+
+```js
+// /lib/son.js
+import father from "./father";
+
+father() + " and Son";
+```
+
+```js
+// /lib/daughter.js
+import father from "./father";
+
+father() + " and Daughter";
+```
+
+```js
+// /lib/father.js
+export default () => "Father";
+```
+
+Both `son.js` and `daughter.js` import `father.js`, so both son and daughter would usually include a copy of father, resulting in duplicated code and larger bundle sizes.
+
+If these files are side loaded, then `father.js` will be split off into a separate file or chunk, and only downloaded once.
+
+- Code shared between multiple entry points is split off into a separate shared file that both entry points import. That way if the user first browses to one page and then to another page, they don't have to download all of the JavaScript for the second page from scratch if the shared part has already been downloaded and cached by their browser.
+
+- Code referenced through an asynchronous `import()` expression will be split off into a separate file and only loaded when that expression is evaluated. This allows you to improve the initial download time of your app by only downloading the code you need at startup, and then lazily downloading additional code if needed later.
+
+- Without code splitting, an import() expression becomes `Promise.resolve().then(() => require())` instead. This still preserves the asynchronous semantics of the expression but it means the imported code is included in the same bundle instead of being split off into a separate file.
+
+Code splitting is enabled by default. You can disable it by setting the `code_splitting` configuration option to `false` in your application's `/config/application.rb`:
+```ruby
+config.proscenium.code_splitting = false
+```
+
 ### JavaScript Caveats
 
 There are a few important caveats as far as JavaScript is concerned. These are [detailed on the esbuild site](https://esbuild.github.io/content-types/#javascript-caveats).
@@ -238,7 +445,7 @@ Note that by default, Proscenium's output will take advantage of all modern CSS
 
 The new CSS nesting syntax is supported, and transformed into non-nested CSS for older browsers.
 
-### Importing from JavaScript
+### Importing CSS from JavaScript
 
 You can also import CSS from JavaScript. When you do this, Proscenium will automatically append each stylesheet to the document's head as a `<link>` element.
 
@@ -252,34 +459,74 @@ export let Button = ({ text }) => {
 
 ### CSS Modules
 
-Proscenium implements a subset of [CSS Modules](https://github.com/css-modules/css-modules). It supports the `:local` and `:global` keywords, but not the `composes` property. It is recommended that you use mixins instead of `composes`, as they work everywhere.
+Proscenium implements a subset of [CSS Modules](https://github.com/css-modules/css-modules). It supports the `:local` and `:global` keywords, but not the `composes` property. (it is recommended that you use mixins instead of `composes`, as they will work everywhere, even in plain CSS files.)
 
-Give any CSS file a `.module.css` extension, and Proscenium will load it as a CSS Module...
+Give any CSS file a `.module.css` extension, and Proscenium will treat it as a CSS Module, transforming all class names with a suffix unique to the file.
 
 ```css
-.header {
-  background-color: #00f;
+.title {
+  font-size: 20em;
 }
 ```
 
 The above input produces:
 
 ```css
-.header5564cdbb {
-  background-color: #00f;
+.title-5564cdbb {
+  font-size: 20em;
 }
 ```
 
-Importing a CSS file from JS will automatically append the stylesheet to the document's head. And the results of the import will be an object of CSS class to module names.
+You now have a unique class name that you can use pretty much anywhere.
+
+#### In your Views
+
+You can reference CSS modules from your Rails views, partials, and layouts using the `css_module` helper, which accepts one or more class names, and will return the equivilent CSS module names - the class name with the unique suffix appended.
+
+With [side-loading](#side-loading) setup, you can use the `css_module` helper as follows.
+
+```erb
+<div>
+  <h1 class="<%= css_module :hello_title %>">Hello World</h1>
+  <p class="<%= css_module :body, paragraph: %>">
+    Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+  </p>
+</div>
+```
+
+`css_module` accepts multiple class names, and will return a space-separated string of transformed CSS module names.
+
+```ruby
+css_module :my_module_name
+# => "my_module_name-ABCD1234"
+```
+
+You can even reference a class from any CSS file by passing the URL path to the file, as a prefix to the class name. Doing so will automatically [side load](#side-loading) the stylesheet.
+
+```ruby
+css_module '/app/components/button.css@big_button'
+# => "big_button"
+```
+
+It also supports NPM packages (already installed in /node_modules):
+
+```ruby
+css_module 'mypackage/button@big_button'
+# => "big_button"
+```
+
+#### In your JavaScript
+
+Importing a CSS module from JS will automatically append the stylesheet to the document's head. And the result of the import will be an object of CSS class to module names.
 
 ```js
 import styles from './styles.module.css'
-// styles == { header: 'header5564cdbb' }
+// styles == { header: 'header-5564cdbb' }
 ```
 
-It is important to note that the exported object of CSS module names is actually a Proxy object. So destructuring the object will not work. Instead, you must access the properties directly.
+It is important to note that the exported object of CSS module names is actually a JavaScript [Proxy](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy) object. So destructuring the object will not work. Instead, you must access the properties directly.
 
-Also, importing a CSS module from another CSS module will result in the same digest string for all classes.
+Also, importing a CSS module into another CSS module will result in the same digest string for all classes.
 
 ### CSS Mixins
 
@@ -377,13 +624,116 @@ console.log(version)
 
 ## Phlex Support
 
-*docs needed*
+[Phlex](https://www.phlex.fun/) is a framework for building fast, reusable, testable views in pure Ruby. Proscenium works perfectly with Phlex, with support for side-loading, CSS modules, and more. Simply write your Phlex classes and inherit from `Proscenium::Phlex`.
+
+```ruby
+class MyView < Proscenium::Phlex
+  def template
+    h1 { 'Hello World' }
+  end
+end
+```
+
+### Side-loading
+
+Any Phlex class that inherits `Proscenium::Phlex` will automatically be [side-loaded](#side-loading).
+
+### CSS Modules
+
+[CSS Modules](#css-modules) are fully supported in Phlex classes, with access to the [`css_module` helper](#in-your-views) if you need it. However, there is a better and more seemless way to reference CSS module classes in your Phlex classes.
+
+Within your Phlex classes, any class names that begin with `@` will be treated as a CSS module class.
+
+```ruby
+# /app/views/users/show_view.rb
+class Users::ShowView < Proscenium::Phlex
+  def template
+    h1 class: :@user_name do
+      @user.name
+    end
+  end
+end
+```
+
+```css
+/* /app/views/users/show_view.module.css */
+.userName {
+  color: red;
+  font-size: 50px;
+}
+```
+
+In the above `Users::ShowView` Phlex class, the `@user_name` class will be resolved to the `userName` class in the `users/show_view.module.css` file.
+
+The view above will be rendered something like this:
+
+```html
+<h1 class="user_name-ABCD1234"></h1>
+```
+
+You can of course continue to reference regular class names in your view, and they will be passed through as is. This will allow you to mix and match CSS modules and regular CSS classes in your views.
+
+```ruby
+# /app/views/users/show_view.rb
+class Users::ShowView < Proscenium::Phlex
+  def template
+    h1 class: :[@user_name, :title] do
+      @user.name
+    end
+  end
+end
+```
+
+```html
+<h1 class="user_name-ABCD1234 title">Joel Moss</h1>
+```
 
 ## ViewComponent Support
 
-*docs needed*
+[ViewComponent](https://viewcomponent.org/) iA framework for creating reusable, testable & encapsulated view components, built to integrate seamlessly with Ruby on Rails. Proscenium works perfectly with ViewComponent, with support for side-loading, CSS modules, and more. Simply write your ViewComponent classes and inherit from `Proscenium::ViewComponent`.
+
+```ruby
+class MyView < Proscenium::ViewComponent
+  def call
+    tag.h1 'Hello World'
+  end
+end
+```
+
+### Side-loading
+
+Any ViewComponent class that inherits `Proscenium::ViewComponent` will automatically be [side-loaded](#side-loading).
+
+### CSS Modules
+
+[CSS Modules](#css-modules) are fully supported in ViewComponent classes, with access to the [`css_module` helper](#in-your-views) if you need it.
 
-## Cache Busting [*COMING SOON*]
+```ruby
+# /app/components/user_component.rb
+class UserComponent < Proscenium::ViewComponent
+  def template
+    div.h1 @user.name, class: css_module(:user_name)
+  end
+end
+```
+
+```css
+/* # /app/components/user_component.module.css */
+.userName {
+  color: red;
+  font-size: 50px;
+}
+```
+
+The view above will be rendered something like this:
+
+```html
+<h1 class="user_name-ABCD1234">Joel Moss</h1>
+```
+
+## Cache Busting
+
+> *COMING SOON*
 
 By default, all assets are not cached by the browser. But if in production, you populate the `REVISION` env variable, all CSS and JS URL's will be appended with its value as a query string, and the `Cache-Control` response header will be set to `public` and a max-age of 30 days.
 
@@ -403,7 +753,7 @@ The cache is set with a `max-age` of 30 days. You can customise this with the `c
 Rails.application.config.proscenium.cache_max_age = 12.months.to_i
 ```
 
-## rjs is back!
+## rjs is back
 
 Proscenium brings back RJS! Any path ending in .rjs will be served from your Rails app. This allows you to import server rendered javascript.
 
@@ -411,9 +761,19 @@ Proscenium brings back RJS! Any path ending in .rjs will be served from your Rai
 
 *docs needed*
 
-## Thanks 🙏
+## Included Paths
+
+By default, Proscenium will serve files ending with any of these extension: `js,mjs,ts,css,jsx,tsx`, and only from `app/assets`, `config`, `app/views`, `lib` and `node_modules` directories.
+
+However, you can customise these paths with the `include_path` config option...
+
+```ruby
+Rails.application.config.proscenium.include_paths << 'app/components'
+```
+
+## Thanks
 
-HUGE thanks go to [Evan Wallace](https://github.com/evanw) and his amazing [esbuild](https://esbuild.github.io/) project. Proscenium would not be possible without it, and it is esbuild that makes this so fast and efficient.
+HUGE thanks 🙏 go to [Evan Wallace](https://github.com/evanw) and his amazing [esbuild](https://esbuild.github.io/) project. Proscenium would not be possible without it, and it is esbuild that makes this so fast and efficient.
 
 Because Proscenium uses esbuild extensively, some of these docs are taken directly from the esbuild docs, with links back to the [esbuild site](https://esbuild.github.io/) where appropriate.
 
@@ -430,7 +790,7 @@ bundle exec rake compile:local
 We have tests for both Ruby and Go. To run the Ruby tests:
 
 ```bash
-bundle exec rake test
+bundle exec sus
 ```
 
 To run the Go tests:
@@ -447,7 +807,7 @@ go test ./internal/builder -bench=. -run="^$" -count=10 -benchmem
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/joelmoss/proscenium. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/joelmoss/proscenium/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at <https://github.com/joelmoss/proscenium>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/joelmoss/proscenium/blob/master/CODE_OF_CONDUCT.md).
 
 ## License