> ## Documentation Index
> Fetch the complete documentation index at: https://docs.readonly.store/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Type-safe readonly file sync with automatic TypeScript code generation

## What is ReadOnly?

ReadOnly is a platform that lets you publish and manage readonly files with automatic TypeScript type generation. Store your data in the cloud, sync it to your projects, and access it with full type safety.

Perfect for:

* Configuration files
* Content management (documents, blog posts, redirects)
* Reference data (countries, currencies, categories)
* Static datasets
* Any JSON data your application needs

## Key Features

<CardGroup cols={2}>
  <Card title="Type-Safe" icon="shield-check">
    Automatic TypeScript type generation from your JSON files with full IntelliSense support.
  </Card>

  <Card title="Real-Time Sync" icon="arrows-rotate">
    Watch mode automatically syncs changes from the dashboard to your local project.
  </Card>

  <Card title="Zero Runtime" icon="gauge">
    Files are cached locally with no runtime overhead - just static imports.
  </Card>

  <Card title="Simple CLI" icon="terminal">
    Intuitive command-line interface for syncing and managing files.
  </Card>
</CardGroup>

## Quick Example

```typescript theme={null}
import { documents, config } from "@readonlystore/client";

// Fully typed with IntelliSense
console.log(documents.title);
console.log(config.apiUrl);
```

## Getting Started

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Get up and running in under 2 minutes.
  </Card>

  <Card title="Installation" icon="download" href="/installation">
    Install the ReadOnly client in your project.
  </Card>

  <Card title="CLI Reference" icon="terminal" href="/client/cli-reference">
    Learn about all available commands.
  </Card>

  <Card title="Usage Guide" icon="code" href="/client/usage">
    Learn how to import and use your files.
  </Card>
</CardGroup>

## How It Works

1. **Create a Project** - Sign up and create a project in the ReadOnly dashboard
2. **Add Files** - Upload your JSON files through the dashboard
3. **Install Client** - Add `@readonlystore/client` to your project
4. **Sync Files** - Run `bunx readonly sync` to download and generate types
5. **Use Your Data** - Import and use your files with full type safety

<Card title="Need Help?" icon="question" href="/help/troubleshooting">
  Check out our troubleshooting guide or contact support.
</Card>