diff --git a/README.md b/README.md index 37747b8..b5ca526 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,25 @@ -

Split Rail

+# Split Rail -

The "Built by TaylorURL" footer bar on TaylorURL sites, as a React component.

+The "Built by TaylorURL" footer bar on TaylorURL sites, as a React component. -

- Version 2026.44.0 - React 17 or later -

+Version 2026.44.0 Split Rail is the thin bar at the very bottom of a TaylorURL site's footer. On the left it says "Built by TaylorURL" and links to [taylorurl.com](https://www.taylorurl.com). On the right it has a Status link to the [status page](https://www.taylorurl.com/status), the site's version and the year. Each site installs it as a dependency instead of keeping its own copy, so a change here reaches every site when it bumps the version. -## What it does +## How it works -- Picks up its colors from the footer it sits in, so it works on light and dark footers -- Shows the version you pass in, and the current year -- Gives the links bigger tap targets on touch screens -- Ships as plain JavaScript with no JSX, so it works in Vite, Create React App and Next.js without extra setup -- Has no dependencies apart from React 17 or later +One file, `src/index.js`. It uses `createElement` instead of JSX so it runs untranspiled in Vite, Create React App and Next.js. The only peer dependency is React 17 or later. -## Install +- **Colors come from the host.** The bar sets no background and no text color. Every tone is mixed from the parent's `currentColor` with `color-mix()`, so the same bar works under a white footer and a near-black one. `--tu-accent` is the one color a site can change, for link hover. +- **Styles ship with it.** The stylesheet is a `