> For the complete documentation index, see [llms.txt](https://shinyobjectlabs.gitbook.io/framework-js/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://shinyobjectlabs.gitbook.io/framework-js/overview/installation.md).

# Installation

## Add the library

Copy the script below and paste it between the `<head>` tags.

```markup
<!-- SO-Framework -->
<script src="https://cdn.shinyobjectlabs.io/libs/framework@0.1.0/framework.js"></script>
```

{% hint style="warning" %}
DEPRECATION WARNING (v0.1.0): **x-mode**l is being replaced by **x-sync** and may be removed in a future release. Please update your code accordingly.
{% endhint %}

### Add the inspector (optional)

The inspector lets you view the component's reactive store without leaving your website.

{% hint style="info" %}
SO-Inspector is a tool for debugging and should be removed once you finish developing the website.
{% endhint %}

{% hint style="info" %}
Add the query parameter `?debug=true` to enable the inspector.
{% endhint %}

Copy the script below and paste it between the `<head>` tags.

```html
<!-- SO-Inspector - Remove once you have finished testing -->
<script type="module" src="https://cdn.shinyobjectlabs.io/libs/inspector@0.0.1/inspector.js"></script>
```
