Skip to content

Commit f35a1a7

Browse files
committed
chore: readme update
1 parent 2495afd commit f35a1a7

File tree

2 files changed

+103
-41
lines changed

2 files changed

+103
-41
lines changed

content/banner.dark.png

-1.61 KB
Loading

readme.md

Lines changed: 103 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,16 @@
55
</p>
66

77
<p align="center">
8-
<strong>⚡️ AI localization toolkit for web & mobile, right from CI/CD.</strong>
8+
<strong>⚡️ AI-powered open-source CLI for web & mobile localization.</strong>
99
</p>
1010

1111
<br />
1212

1313
<p align="center">
14-
<a href="https://lingo.dev">Website</a> •
14+
<a href="https://docs.lingo.dev">Docs</a> •
1515
<a href="https://github.com/lingodotdev/lingo.dev/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22">Contribute</a> •
16-
<a href="#-github-action">GitHub Action</a>
16+
<a href="#-github-action">GitHub Action</a> •
17+
<a href="#">Star the repo</a>
1718
</p>
1819

1920
<p align="center">
@@ -30,26 +31,97 @@
3031

3132
<br />
3233

33-
Lingo.dev automates software localization end-to-end using latest LLM models.
34+
Lingo.dev is a community-driven, open-source CLI for AI-powered web and mobile app localization.
3435

35-
It produces authentic translations instantly, eliminating manual work and management overhead. Lingo.dev Localization Engine understands product context, creating perfected translations that native speakers expect across 60+ languages. As a result, teams do localization 100x faster, with state-of-the-art quality, shipping features to more paying customers worldwide.
36+
Lingo.dev is designed to produce authentic translations instantly, eliminating manual work and management overhead. As a result, teams do accurate localization 100x faster, shipping features to more happy users worldwide. It can be used with your own LLM or with Lingo.dev-managed Localization Engine.
37+
38+
> **Little-known fact:** Lingo.dev began as a small project at a student hackathon back in 2023! Many iterations later, we got accepted into Y Combinator in 2024, and we're now hiring! Interested in building the next-gen localization tools? Send your CV to careers@lingo.dev 🚀
39+
40+
## 📑 In This Guide
41+
42+
- [Quickstart](#-quickstart) - Get started in minutes
43+
- [Caching](#-caching-with-i18nlock) - Optimize translation updates
44+
- [GitHub Action](#-github-action) - Automate localization in CI/CD
45+
- [Features](#-supercharged-features) - What makes Lingo.dev powerful
46+
- [Documentation](#-documentation) - Detailed guides and references
47+
- [Contribute](#-contribute) - Join our community
3648

3749
## 💫 Quickstart
3850

39-
1. Create an account on [the website](https://lingo.dev)
51+
Lingo.dev CLI is designed to work with both your own LLM, and Lingo.dev-managed Localization Engine built on top of latest SOTA (state-of-the-art) LLMs.
52+
53+
### Using Your Own LLM (BYOK or Bring Your Own Key)
54+
55+
1. Create an `i18n.json` configuration file:
56+
57+
```json
58+
{
59+
"version": 1.5,
60+
"provider": {
61+
"id": "anthropic",
62+
"model": "claude-3-7-sonnet-latest",
63+
"prompt": "You're translating text from {source} to {target}."
64+
},
65+
"locale": {
66+
"source": "en",
67+
"targets": ["es", "fr", "de"]
68+
}
69+
}
70+
```
71+
72+
2. Set your API key as an environment variable:
73+
74+
```bash
75+
export ANTHROPIC_API_KEY=your_anthropic_api_key
76+
# or for OpenAI
77+
export OPENAI_API_KEY=your_openai_api_key
78+
```
4079

41-
2. Initialize your project:
80+
3. Run the localization:
4281

43-
```bash
44-
npx lingo.dev@latest init
45-
```
82+
```bash
83+
npx lingo.dev@latest i18n
84+
```
4685

47-
3. Check out our docs: [docs.lingo.dev](https://docs.lingo.dev)
86+
### Using Lingo.dev Cloud
87+
88+
Oftentimes, production-grade apps require features like translation memory, glossary support, and localization quality assurance. Also, sometimes, you want an expert to decide for you which LLM provider and model to use, and to update the model automatically when new ones are released. Lingo.dev is a managed Localization Engine that provides these features:
89+
90+
1. Create an `i18n.json` configuration file (without provider node):
91+
92+
```json
93+
{
94+
"version": 1.5,
95+
"locale": {
96+
"source": "en",
97+
"targets": ["es", "fr", "de"]
98+
}
99+
}
100+
```
101+
102+
2. Authenticate with Lingo.dev:
103+
104+
```bash
105+
npx lingo.dev@latest auth --login
106+
```
48107

49-
4. Localize your app (takes seconds):
50-
```bash
51-
npx lingo.dev@latest i18n
52-
```
108+
3. Run localization:
109+
110+
```bash
111+
npx lingo.dev@latest i18n
112+
```
113+
114+
## 📖 Documentation
115+
116+
For detailed guides and API references, visit the [documentation](https://lingo.dev/go/docs).
117+
118+
## 🔒 Caching with `i18n.lock`
119+
120+
Lingo.dev uses an `i18n.lock` file to track content checksums, ensuring only changed text gets translated. This improves:
121+
122+
- ⚡️ **Speed**: Skip already translated content
123+
- 🔄 **Consistency**: Prevent unnecessary retranslations
124+
- 💰 **Cost**: No billing for repeated translations
53125

54126
## 🤖 GitHub Action
55127

@@ -65,39 +137,29 @@ This action runs `lingo.dev i18n` on every push, keeping your translations up-to
65137

66138
For pull request mode and other configuration options, visit our [GitHub Action documentation](https://docs.lingo.dev/setup/gha).
67139

68-
## 🥇 Why teams choose Lingo.dev
69-
70-
- 🔥 **Instant integration**: Set up in minutes
71-
- 🔄 **CI/CD Automation**: Seamless dev pipeline integration
72-
- 🌍 **60+ Languages**: Expand globally effortlessly
73-
- 🧠 **AI Localization Engine**: Translations that truly fit your product
74-
- 📊 **Format Flexible**: Supports JSON, YAML, CSV, Markdown, and more
140+
## ⚡️ Lingo.dev's Superpowers
75141

76-
## 🛠️ Supercharged features
142+
## ⚡️ Lingo.dev's Superpowers
77143

78-
- ⚡️ **Lightning-Fast**: AI localization in seconds
79-
- 🔄 **Auto-Updates**: Syncs with the latest content
80-
- 🌟 **Native Quality**: Translations that sound authentic
81-
- 👨‍💻 **Developer-Friendly**: CLI that integrates with your workflow
82-
- 📈 **Scalable**: For growing startups and enterprise teams
83-
84-
## 📚 Documentation
85-
86-
For detailed guides and API references, visit the [documentation](https://lingo.dev/go/docs).
144+
- 🔥 **Instant integration**: Works with your codebase in minutes
145+
- 🔄 **CI/CD Automation**: Set it and forget it
146+
- 🌍 **Global reach**: Ship to users everywhere
147+
- 🧠 **AI-powered**: Uses latest language models for natural translations
148+
- 📊 **Format-agnostic**: JSON, YAML, CSV, Markdown, Android, iOS, and many more
149+
- 🔍 **Clean diffs**: Preserves your file structure exactly
150+
- ⚡️ **Lightning-fast**: Translations in seconds, not days
151+
- 🔄 **Always synced**: Automatically updates when content changes
152+
- 🌟 **Human quality**: Translations that don't sound robotic
153+
- 👨‍💻 **Built by devs, for devs**: We use it ourselves daily
154+
- 📈 **Grows with you**: From side project to enterprise scale
87155

88156
## 🤝 Contribute
89157

90-
Interested in contributing, even if you aren't a customer?
91-
92-
Check out the [Good First Issues](https://github.com/lingodotdev/lingo.dev/labels/good%20first%20issue) and read the [Contributing Guide](./CONTRIBUTING.md).
93-
94-
## 👨‍💻 Team
158+
Lingo.dev is community-driven, so we welcome all contributions!
95159

96-
- **[Veronica](https://github.com/vrcprl)**
97-
- **[Max](https://github.com/maxprilutskiy)**
98-
- **[Matej](https://github.com/mathio)**
160+
Have an idea for a new feature? Create a GitHub issue!
99161

100-
Questions or inquiries? Email veronica@lingo.dev
162+
Want to contribute? Create a pull request!
101163

102164
## 🌐 Readme in other languages
103165

0 commit comments

Comments
 (0)