accessify-widget 0.1.0 → 0.2.1

package/README.md

@@ -2,13 +2,35 @@
 
 The public Accessify-Widget package for script-tag installs and npm-based integrations.
 
+## Included Feature Set
+
+The public widget focuses on the adjustments that are most useful in day-to-day usage:
+
+- `contrast` with `light`, `dark`, and `high`
+- `text-size`
+- `keyboard-nav`
+- `focus-highlight`
+- `link-highlight`
+- `reading-guide`
+- `reading-mask`
+- `animation-stop`
+- `hide-images`
+- `big-cursor`
+- `page-structure`
+- `tts`
+- `text-simplify`
+- `alt-text`
+- `auto-scan`
+
+The widget UI ships with a built-in language selector for the top 20 world languages.
+
 ## CDN Install
 
 For Framer, Webflow, Shopify theme code, and plain HTML, use the public widget bundle:
 
 ```html
 <script
-  src="https://cdn.jsdelivr.net/npm/accessify-widget/dist/widget.js"
+  src="https://cdn.jsdelivr.net/npm/accessify-widget@latest/dist/widget.js"
   data-accessify
   data-position="bottom-right"
   data-theme="auto"
@@ -28,7 +50,7 @@ Supported data attributes:
 - `data-compact`
 - `data-z-index`
 
-If this URL returns `404`, the package has not been published to npm yet. Publish the release first, then use the same snippet.
+If this URL returns `404`, wait a minute for CDN propagation, then confirm the package was published to npm.
 
 ## Framer
 
@@ -61,12 +83,38 @@ If you are using a dashboard-issued site key, the all-in-one bundle can also aut
 
 ```html
 <script
-  src="https://cdn.jsdelivr.net/npm/accessify-widget/dist/widget.js"
+  src="https://cdn.jsdelivr.net/npm/accessify-widget@latest/dist/widget.js"
   data-site-key="sk_site_your_key"
   defer
 ></script>
 ```
 
+Recommended flow:
+
+1. Open `https://accessify-dashboard.pages.dev`
+2. Register your site domain
+3. Add an AI provider key in the dashboard
+4. Paste the generated `data-site-key` snippet into your site
+
+In this mode, the browser only sees the public site key. The provider key stays behind the Accessify proxy on Cloudflare Workers.
+
+There is currently no separate AI translation feature. `text-simplify` and `alt-text` are the supported AI flows today.
+
+## Direct AI Mode
+
+For local testing or short-lived demos, you can also pass an OpenRouter key directly:
+
+```html
+<script
+  src="https://cdn.jsdelivr.net/npm/accessify-widget@latest/dist/widget.js"
+  data-accessify
+  data-openrouter-key="sk-or-your-key"
+  defer
+></script>
+```
+
+This is less secure because the key is visible in the frontend source.
+
 ## Guides
 
 - [Quick Start](https://github.com/maddesv1-ctrl/accessify-widget/blob/main/apps/docs/src/content/docs/getting-started/quick-start.md)
@@ -74,3 +122,9 @@ If you are using a dashboard-issued site key, the all-in-one bundle can also aut
 - [Custom HTML](https://github.com/maddesv1-ctrl/accessify-widget/blob/main/apps/docs/src/content/docs/platforms/html.md)
 - [Webflow](https://github.com/maddesv1-ctrl/accessify-widget/blob/main/apps/docs/src/content/docs/platforms/webflow.md)
 - [Shopify](https://github.com/maddesv1-ctrl/accessify-widget/blob/main/apps/docs/src/content/docs/platforms/shopify.md)
+
+## Source Layout
+
+- Widget source: `packages/core/src`
+- Dashboard source: `apps/dashboard/index.html`
+- API proxy source: `packages/api/src`