Skip to content

Commit 8d4357b

Browse files
maxprilutskiymaxprilutskiy
committed
docs: upd readme
1 parent f4e7d58 commit 8d4357b

1 file changed

Lines changed: 14 additions & 76 deletions

File tree

‎readme.md‎

Lines changed: 14 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -11,101 +11,45 @@
1111
[![Release](https://github.com/replexica/replexica/actions/workflows/release.yml/badge.svg)](https://github.com/replexica/replexica/actions/workflows/release.yml)
1212
[![GitHub License](https://img.shields.io/github/license/replexica/replexica)](https://github.com/replexica/replexica/blob/main/LICENSE.md)
1313

14-
[Docs](https://github.com/replexica/replexica/wiki) •
14+
[Docs](https://replexica.com/docs) •
1515
[Discord](https://discord.gg/GeK6AuSqzw) •
1616
[Website](https://replexica.com) •
1717
[Twitter](https://twitter.com/replexica)
1818

19-
Replexica is an i18n toolkit for React, to ship multi-language apps fast.
19+
Replexica is an i18n platform for React, to ship multi-language apps fast.
2020

21-
It comes in two parts:
21+
Replexica supports React apps, and several i18n formats, including JSON-free, experimental Replexica Compiler format, `.md` files for Markdown content, and classic JSON and YAML-based formats.
2222

23-
1. [Experimental] **Replexica Compiler** - an open-source compiler plugin for React (experimental, Next.js App Router only);
24-
1. **Replexica API** - an i18n API in the cloud that performs translations using context-aware LLMs (Usage based, has a free tier.).
25-
26-
Replexica supports several i18n formats:
27-
28-
1. JSON-free, experimental Replexica Compiler format;
29-
1. `.md` files for Markdown content;
30-
1. Classic JSON and YAML-based formats.
23+
Replexica comes with an open-source compiler plugin for React (experimental), and an i18n API in the cloud that performs translations using context-aware LLMs.
3124

3225
## Getting Started
3326

34-
Check out our [Docs](https://github.com/replexica/replexica/wiki) for more detailed guides on how to use Replexica with your app.
27+
Check out our [Docs](https://replexica.com/docs) for more detailed guides on how to use Replexica with your app.
3528

3629
## What's under the hood
3730

38-
Replexica is a full-stack LLM-powered i18n tool for React, and it consists of **two main parts**:
31+
Replexica is a full-stack LLM-powered i18n platform for React, and it consists of **two main parts**:
3932

40-
1. **Replexica i18n Compiler** (this repo) - an open-source compiler plugin for React:
33+
1. **Replexica i18n Compiler** (this repo, experimental) - an open-source compiler plugin for React:
4134
* Doesn't require extracting strings into JSON files;
4235
* Seamlessly integrates with React build system;
4336
* Infers metadata and user-facing text from the app;
4437
* Prepares the content for further context-aware translation.
4538

46-
The compiler hooks into the build process, infers metadata from the app, such as the text that needs to be translated and the context it's in. The Abstract Syntax Tree (AST) is traversed to gather the metadata, the context, and the text that needs to be translated. This metadata is then stored alongside the build artifacts.
47-
4839
1. **Replexica i18n API** ([replexica.com](https://replexica.com)) - an i18n API in the cloud that translates apps into multiple languages, using LLMs, fast:
49-
* ~~$0/mo + usage, with free tier;~~ Entirely free, during the launch period;
40+
* $0/mo + usage-based API;
5041
* Full context awareness + brand voice;
51-
* State-of-the-art quality translations (adding more new languages soon!) via a mix of open-source and proprietary AI models;
52-
* API is open, so anyone could build their own translation engine (self-hosting guide coming soon).
53-
54-
The i18n engine uses AI to translate the text, and the more it's used, the better it gets. The very first version used plain gpt-3.5, though currently it's more like a mix of Llama + Google Vertex AI + GPT + Mixtral, and we're switching between models regularly as we improve the API.
55-
56-
The core idea behind Replexica is simple: apps must be multi-language by default, from day one. **The Internet is global, and so must be any software that runs on it.**
57-
58-
## Why
59-
60-
Having built tens of side-projects / micro-startups over the years, we found one thing to be particularly annoying: adding i18n to the app. We wanted to **ship, and ship fast**, not to mess with JSON files or extraction scripts.
61-
62-
So it got us thinking: why not build a tool that makes multi-language apps simpler? I mean, anyone who's tried to add i18n to their project knows it's a headache.
42+
* State-of-the-art quality translations via a mix of open-source and proprietary AI models.
6343

64-
That's why we teamed up build a React compiler coupled with an AI-powered API, to make i18n as simple as possible, at the most fundamental level.
44+
The core idea behind Replexica is simple: apps must be multi-language by default, from day one.
6545

66-
## Roadmap
46+
**The Internet is global, and so must be any software that runs on it.**
6747

68-
Here are the main features we're working on next:
48+
## Authors
6949

70-
The more detailed roadmap is below:
71-
72-
* [x] Replexica Compiler
73-
* [x] Next.js App Router
74-
* [ ] Next.js Pages Router
75-
* [ ] Remix
76-
* [ ] Create React App
77-
* [x] Replexica Framework
78-
* [x] Core JSX translation
79-
* [x] Custom context hints
80-
* [x] Translation of JSX attributes (title, alt, placeholder)
81-
* [ ] Translation of generic literals with helper functions
82-
* [ ] Translation of arbitrary attributes
83-
* [x] Replexica Cloud
84-
* [x] AI Translation Engine
85-
* [x] Context awareness aka **Brand voice**
86-
* [ ] Supported locales (production-ready, state-of-the-art quality)
87-
* [x] English
88-
* [x] Spanish
89-
* [x] French
90-
* [x] Catalan
91-
* [ ] Italian
92-
* [ ] 20+ more languages comfing soon
93-
* [ ] (Create a GitHub issue to request a new language!)
94-
* [ ] Self-hosting guides / docs
95-
* [x] Replexica CLI
96-
* [x] CLI for Replexica Platform
97-
* [x] Open-source API schema
98-
* [ ] GitHub Actions integration
99-
100-
## Core Team
101-
102-
We're a lean team of two:
103-
104-
* **[Veronica](https://github.com/vrcprl)** - Product, Data Science, and LLMs.
50+
* **[Veronica](https://github.com/vrcprl)** - Data Science, and LLMs.
10551
* **[Max](https://github.com/maxprilutskiy)** - React, Typescript, and Compilers.
10652

107-
We've also got a few (11 at the moment) contributors who signed up to help us with the project, and we're always looking for more. If you're interested in contributing, please drop by our Discord channel and say hi!
108-
10953
## Contributing
11054

11155
If you're building a side-project, or a startup, or you're working at a big company that uses Replexica - we'd love to hear from you!
@@ -114,13 +58,7 @@ If you're building a side-project, or a startup, or you're working at a big comp
11458
* **Feature requests** - tell us what you need, and we'll do our best to build it.
11559
* **Bug reports** - if you find a bug, please let us know, and we'll fix it as soon as we physically can.
11660

117-
Also the special one:
118-
119-
* **Complaints** - if you're unhappy with _literally anything_ about your current i18n approach - drop by our Discord!
120-
121-
Last time someone complained we built a feature for them and made it production-ready within 48 hours.
122-
123-
Lastly, we've recently created a [Discord channel](https://discord.gg/GeK6AuSqzw): come say hi! 👋
61+
* **Contributions** - if you're a developer, and you'd like to contribute to Replexica, please check out our [Contributing Guide](./CONTRIBUTING.md).
12462

12563
## Questions
12664

0 commit comments

Comments
 (0)