Skip to content

Commit e14b9c3

Browse files
committed
docs: upd readme
1 parent 6c50fc4 commit e14b9c3

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

readme.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ That's where Replexica comes in: it's a build system plugin (+ AI engine in the
1616

1717
## API
1818

19+
> [!NOTE]
20+
> This guide is for Next.js App Router apps only. Support for other setups is coming soon (ETA April 2024).
21+
1922
```js
2023
// next.config.mjs
2124

@@ -43,32 +46,29 @@ export default compiler.next(
4346

4447
The Replexica compiler is open-source, and the platform API is open, allowing you to build your own translation engine.
4548

46-
We're also developing our own AI translation platform ([replexica.com](https://replexica.com)), to make it even easier to launch your first multi-language app!
49+
We're also developing our own i18n engine called [Replexica Cloud](https://replexica.com), to make it even easier to ship your first multi-language app!
4750

4851
- [x] Replexica Compiler
4952
- [x] Next.js App Router
5053
- [ ] Next.js Pages Router (April 2024)
5154
- [ ] Remix (May 2024)
5255
- [ ] Create React App (May 2024)
5356
- [x] Replexica Framework
54-
- [x] JSX translation
57+
- [x] Core JSX translation
5558
- [x] Custom context hints
56-
- [x] Skipper for non-translatable text
57-
- [x] Avoid fetching unused translations
5859
- [x] Translation of JSX attributes (title, alt, placeholder)
5960
- [ ] Translation of generic literals with helper functions
6061
- [ ] Translation of arbitrary attributes
61-
- [x] Replexica Platform
62+
- [x] Replexica Cloud
6263
- [x] AI Translation Engine
63-
- [x] Translation memory
6464
- [x] Context awareness aka **Brand voice**
6565
- [ ] Supported locales (production-ready, state-of-the-art quality)
6666
- [x] English
6767
- [x] Spanish
6868
- [ ] French (April 2024)
6969
- [ ] German (April 2024)
7070
- [ ] (Create a GitHub issue to request a new language!)
71-
- [ ] Automated i18n quality checks (May 2024)
71+
- [ ] Quality checks (May 2024)
7272
- [ ] Documentation/examples on self-hosted translation engine
7373
- [x] Replexica CLI
7474
- [x] CLI for Replexica Platform
@@ -80,7 +80,7 @@ We're also developing our own AI translation platform ([replexica.com](https://r
8080
Replexica is a compiler plugin that integrates with the build system, collecting all user-facing text in the app and preparing it for translation with the Replexica platform. Here's how it works:
8181

8282
1. **Infers** metadata from your app, such as the text that needs to be translated and its context. This metadata is then stored alongside the build artifacts.
83-
1. **Translates** the text using the CLI that connects to the Replexica platform. The platform uses AI to translate the text, and the more you use it, the better it gets. The API is open, so you can build your own translation engine if you wish!
83+
1. **Translates** the text using the CLI that connects to the Replexica Cloud. The cloud engine uses AI to translate the text, and the more you use it, the better it gets. The API is open, so you can build your own translation engine if you wish!
8484
1. **Injects** the translations back into your app, so that the translated text is displayed to the user, based on their locale.
8585

8686
With Replexica, you can build multi-language apps without the hassle of managing JSON files, and with the power of AI translation.
@@ -233,7 +233,7 @@ pnpm run start
233233
> `pnpm replexica i18n` must be run after every build, to fetch the latest translations from the Replexica platform. It must be run in CI/CD pipelines as well, right after the `build` step.
234234
235235
> [!NOTE]
236-
> We know that running `pnpm replexica i18n` after every build and running the build twice can be a bit cumbersome. We're working on a solution to make this process more streamlined!
236+
> We know that running `pnpm replexica i18n` after every build and running the build twice can be a bit cumbersome. We're working on a solution to make this process more streamlined (ETA April 2024 🙏)!
237237
238238
### Step 5 (Optional). Test the result
239239

@@ -274,4 +274,4 @@ So, whatever approach you choose for switching between locales, just be sure to
274274

275275
If you have any questions, feel free to create a GitHub issue!
276276

277-
Also, we're [on Discord](https://discord.gg/P2J3dGUM).
277+
Also, we're [on Discord](https://discord.gg/P2J3dGUM): come say hi!

0 commit comments

Comments
 (0)