Skip to content

Commit cba5d80

Browse files
committed
Update docs with GitHub integration and open source emphasis
1 parent be48471 commit cba5d80

File tree

2 files changed

+93
-11
lines changed

2 files changed

+93
-11
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,17 +45,22 @@ ext install nickprotop.localization-manager
4545

4646
**👉 [Try LRM Cloud Free →](https://lrm-cloud.com)** | **[Documentation →](docs/CLOUD.md)**
4747

48-
Cloud platform for team-based localization management with web dashboard and CLI sync.
48+
Cloud platform for team-based localization management with web dashboard and CLI sync. **100% open source** — self-host with no restrictions or use the managed platform.
4949

5050
**Features:**
5151
- Web-based translation editor with real-time collaboration
5252
- Team management with role-based access (Owner, Admin, Member, Viewer)
53+
- GitHub integration with push/pull and automatic PR creation
5354
- 10 translation providers (free + paid + bring your own keys)
54-
- Git-style CLI sync: `lrm push` / `lrm pull`
55-
- Usage tracking and analytics
55+
- Git-style CLI sync with three-way merge: `lrm push` / `lrm pull`
56+
- Translation Memory and Glossary management
5657
- REST API for custom integrations
5758

58-
**Plans:**
59+
**Deployment Options:**
60+
- **Hosted**: Use [lrm-cloud.com](https://lrm-cloud.com) — no setup required
61+
- **Self-hosted**: Deploy on your infrastructure with Docker — unlimited usage, full data ownership
62+
63+
**Plans (Hosted):**
5964
| Plan | Price | Translation Credits | Projects | Team |
6065
|------|-------|---------------------|----------|------|
6166
| Free | $0/mo | 5K chars | 3 | Solo |

docs/CLOUD.md

Lines changed: 84 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,25 @@ LRM Cloud is a web-based platform for team localization management with real-tim
66

77
![LRM Cloud Dashboard](../assets/cloud-dashboard.png)
88

9-
## Open Source & Deployment Options
9+
## 100% Open Source
1010

11-
LRM is a fully **open source project** under the MIT license. You have two options for using LRM Cloud:
11+
LRM is a **fully open source project** under the MIT license. Unlike other localization platforms that only open-source parts of their system, LRM provides the **complete stack**:
1212

13-
### Option 1: Hosted Platform (Recommended)
13+
- **CLI Tool** - Open source (MIT)
14+
- **Cloud Backend API** - Open source (MIT)
15+
- **Web Frontend** - Open source (MIT)
16+
- **VS Code Extension** - Open source (MIT)
17+
- **Docker Deployment** - Open source (MIT)
18+
19+
This means you can:
20+
- **Self-host** with no feature restrictions
21+
- **Modify** the source code for your needs
22+
- **Audit** the code for security compliance
23+
- **Contribute** improvements back to the community
24+
25+
## Deployment Options
26+
27+
### Option 1: Hosted Platform
1428

1529
Use our managed cloud platform at **[lrm-cloud.com](https://lrm-cloud.com)** — no setup required.
1630

@@ -22,9 +36,17 @@ Use our managed cloud platform at **[lrm-cloud.com](https://lrm-cloud.com)** —
2236

2337
All plans include the full feature set. [See pricing details](#plans--pricing) for limits.
2438

25-
### Option 2: Self-Hosted
39+
### Option 2: Self-Hosted (No Restrictions)
2640

27-
Deploy LRM Cloud on your own infrastructure using Docker Compose.
41+
Deploy LRM Cloud on your own infrastructure using Docker Compose. **All features are available** — no artificial limitations, no phone-home, no license checks.
42+
43+
**Self-hosted benefits:**
44+
- **Unlimited** translation characters (use your own API keys)
45+
- **Unlimited** projects and team members
46+
- **Complete data ownership** — your data stays on your servers
47+
- **GDPR/compliance friendly** — control your data jurisdiction
48+
- **Air-gapped deployments** — works offline with Ollama for translation
49+
- **Customizable** — modify the source code as needed
2850

2951
**Requirements:**
3052
- Docker & Docker Compose
@@ -58,7 +80,7 @@ The `deploy.sh` script handles building and deploying.
5880
| Service | Purpose |
5981
|---------|---------|
6082
| nginx | Reverse proxy, SSL termination |
61-
| api | REST API server |
83+
| api | REST API server (.NET 9) |
6284
| web | Blazor WASM frontend |
6385
| postgres | PostgreSQL 16 database |
6486
| redis | Session cache |
@@ -74,7 +96,8 @@ For detailed deployment instructions, see [`cloud/deploy/README.md`](../cloud/de
7496
- **Multiple Translation Providers** - Google, DeepL, OpenAI, Claude, Azure, and more
7597
- **Translation Memory** - Automatic caching for cost savings and consistency
7698
- **Glossary Management** - Enforce consistent terminology across translations
77-
- **CLI Sync** - Bidirectional sync between local files and cloud
99+
- **CLI Sync** - Bidirectional sync between local files and cloud with three-way merge
100+
- **GitHub Integration** - Connect repositories, push/pull translations, auto-create PRs
78101
- **Team Collaboration** - Organizations with role-based access control
79102
- **Multi-format Support** - RESX, JSON, i18next, Android XML, iOS strings
80103

@@ -295,6 +318,60 @@ lrm cloud push
295318

296319
See [Cloud Sync Guide](CLOUD_SYNC.md) for complete documentation.
297320

321+
## GitHub Integration
322+
323+
Connect your GitHub repository to LRM Cloud for seamless version control integration.
324+
325+
### Connecting a Repository
326+
327+
1. Go to **Project Settings** > **GitHub**
328+
2. Click **"Connect to GitHub"**
329+
3. Authorize LRM Cloud to access your repository
330+
4. Select the repository and branch
331+
332+
### Push to GitHub
333+
334+
Push translations from LRM Cloud to your GitHub repository:
335+
336+
1. Make changes in the web editor or via CLI sync
337+
2. Click **"Push to GitHub"** in project settings
338+
3. LRM creates a branch and opens a pull request
339+
4. Review and merge the PR in GitHub
340+
341+
### Pull from GitHub
342+
343+
Pull translations from GitHub into LRM Cloud:
344+
345+
1. Click **"Pull from GitHub"** in project settings
346+
2. LRM performs a **three-way merge**:
347+
- Compares GitHub, Cloud, and last synced state
348+
- Auto-merges non-conflicting changes
349+
- Presents conflicts for manual resolution
350+
3. Review and apply changes
351+
352+
### Three-Way Merge
353+
354+
LRM uses proper three-way merge (like Git) at every sync boundary:
355+
356+
- **CLI ↔ Cloud**: Merges local file changes with cloud changes
357+
- **Cloud ↔ GitHub**: Merges cloud edits with repository changes
358+
359+
This means:
360+
- Changes in different places merge automatically
361+
- Same change in both places = no conflict
362+
- Only truly divergent changes require resolution
363+
- No accidental overwrites
364+
365+
### Conflict Resolution
366+
367+
When conflicts occur:
368+
369+
| Strategy | Description |
370+
|----------|-------------|
371+
| **GitHub** | Accept all GitHub values |
372+
| **Cloud** | Keep all Cloud values |
373+
| **Prompt** | Choose per-conflict in UI |
374+
298375
## Teams & Organizations
299376

300377
Organizations enable team collaboration on localization projects.

0 commit comments

Comments
 (0)