Skip to content

Commit 05f4ef0

Browse files
committed
feat: add the first version of the readme
1 parent 5c01066 commit 05f4ef0

File tree

1 file changed

+44
-1
lines changed

1 file changed

+44
-1
lines changed

readme.md

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,47 @@
11
<p align="center">
22
<img src="./content/banner.light.png#gh-light-mode-only">
33
<img src="./content/banner.dark.png#gh-dark-mode-only">
4-
</p>
4+
</p>
5+
6+
# Replexica
7+
8+
Replexica is an open-source i18n compiler plugin for React + an AI translation platform.
9+
10+
Multi-language products get more users: 75% of the world doesn't speak English. But building such apps is a pain. *Extract* strings to JSON files, then *update* translations every time there is a change - it's a nightmare.
11+
12+
That's where Replexica comes in: it's a build system plugin, that translates React apps to multiple languages with AI, and doesn't require JSON files extraction / maintenance.
13+
14+
Replexica compiler is open-source, and the API is open so you can build your own translation engine. We're also building our own AI translation platform, to make it even easier to roll out your first multi-language app ;)
15+
16+
- [x] Replexica Compiler
17+
- [x] Next.js
18+
- [ ] Remix
19+
- [ ] Create React App
20+
- [x] Replexica Framework
21+
- [x] JSX translation
22+
- [x] Custom context hints
23+
- [ ] Translation of string literals using a helper
24+
- [x] Replexica Platform
25+
- [x] AI Translation Engine
26+
- [x] Translation memory
27+
- [x] Context awareness aka **Brand voice**
28+
- [ ] i18n overrides
29+
- [ ] i18n quality checks
30+
- [x] Replexica CLI
31+
- [x] CLI for Replexica Platform
32+
- [x] Open-source API schema
33+
- [ ] GitHub Actions integration
34+
35+
## How it works
36+
37+
Replexica is a compiler plugin. It hooks into your build system, and collects all the user-facing text in your app, getting it ready for translation with the Replexica platform. Here's how it works:
38+
39+
1. **Infers** metadata from your app, like the text that needs to be translated and the context it's in. The metadata is then stored alongside your build artifacts.
40+
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 want!
41+
1. **Injects** the translations back into your app, so that the translated text is displayed to the user, based on their locale.
42+
43+
So, with Replexica, you can build multi-language apps without the hassle of JSON files, and with the power of AI translation.
44+
45+
## Getting started
46+
47+
## License

0 commit comments

Comments
 (0)