Skip to content

Commit c4f4f27

Browse files
committed
chore: move generic readme to the main readme
1 parent b5cbeb8 commit c4f4f27

File tree

2 files changed

+14
-27
lines changed

2 files changed

+14
-27
lines changed

cmp/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
11
# Lingo.dev compiler
22

3+
Lingo.dev compiler with automatic translation support for React applications.
4+
5+
This package provides plugins for multiple bundlers (Vite, Webpack) and Next.js that
6+
automatically transforms React components to inject translation calls.
7+
8+
## Features
9+
10+
- **Automatic JSX text transformation** - Automatically detects and transforms translatable text in JSX
11+
- **Opt-in or automatic** - Configure whether to require `'use i18n'` directive or transform all files
12+
- **Multi-bundler support** - Works with Vite, Webpack and Next.js (both Webpack and Turbopack builds)
13+
- **Translation server** - On-demand translation generation during development
14+
- **AI-powered translations** - Support for multiple LLM providers and Lingo.dev Engine
15+
316
## Getting started
417

518
Install the package - `pnpm install @lingo.dev/compile`

cmp/compiler/README.md

Lines changed: 1 addition & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,6 @@
11
# @lingo.dev/compiler
22

3-
Official Lingo.dev compiler with automatic translation support for React applications.
4-
5-
This package provides plugins for multiple bundlers (Vite, Webpack, Rollup, esbuild) and a Next.js loader that
6-
automatically transforms React components to inject translation calls. It uses a hash-based metadata system to track
7-
translatable text across your application.
8-
9-
## Features
10-
11-
- **Automatic JSX text transformation** - Automatically detects and transforms translatable text in JSX
12-
- **Hash-based metadata** - Generates unique hashes for each translatable text based on content, component name, and
13-
file path
14-
- **Opt-in or automatic** - Configure whether to require `'use i18n'` directive or transform all files
15-
- **Multi-bundler support** - Works with Vite, Webpack, Rollup, esbuild, and Next.js
16-
- **Built on unplugin** - Unified plugin API across all bundlers
17-
- **Metadata tracking** - Maintains `.lingo/metadata.json` with all translatable content
18-
- **Translation server** - On-demand translation generation during development
19-
- **AI-powered translations** - Support for multiple LLM providers and Lingo.dev Engine
20-
21-
## Installation
22-
23-
```bash
24-
npm install @lingo.dev/compiler
25-
# or
26-
pnpm add @lingo.dev/compiler
27-
# or
28-
yarn add @lingo.dev/compiler
29-
```
3+
See the main [README](../README.md) for general information.
304

315
## Structure
326

0 commit comments

Comments
 (0)