Skip to content

Commit d9c10d0

Browse files
committed
docs: add getting started guide link to the readme
1 parent 4b2a9bf commit d9c10d0

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Getting Started
22

3-
As mentioned in the [README](README.md), today Replexica works incredibly well only with Nextjs (App Router).
3+
As mentioned in the [README](/README.md), today Replexica works incredibly well only with Nextjs (App Router).
44

55
While we're working hard to make it work with other frameworks, let's see how to get started with Nextjs!
66

readme.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ It ships in two parts:
1818
1. **Replexica Compiler** - an open-source compiler plugin for React;
1919
1. **Replexica API** - an i18n API in the cloud that performs translations, using AI models.
2020

21+
_Looking to jump right in? Check out the [Getting Started](/getting-started.md) guide for Next.js App Router!_
22+
2123
## Why
2224

2325
75% of the world doesn't speak English. So, if the app is multilingual, it can reach many more users!
@@ -26,7 +28,7 @@ But, making an app multilingual is a headache: extracting text, managing JSON fi
2628

2729
That's where Replexica comes in: it's an AI-powered i18n engine, that integrates with React, to make the app multilingual right during the build, and scale to more international users much faster.
2830

29-
The best part - *you don't even have to deal with JSON files!* (You can though, if you want to, Replexica supports that too.)
31+
The best part - _you don't even have to deal with JSON files!_ (You can though, if you want to, Replexica supports that too.)
3032

3133
### Does Replexica work with ... ?
3234

@@ -247,7 +249,7 @@ export default replexica.next(
247249
> [!NOTE]
248250
> This guide is for Next.js App Router apps only. Guides for other setups are coming soon (ETA April 2024). <https://github.com/replexica/replexica/issues/25>
249251
250-
If you plan on having `'use client'` components *at least somewhere* in your app (you probably do), you'll need to also wrap your entire component tree in `<ReplexicaProvider />`:
252+
If you plan on having `'use client'` components _at least somewhere_ in your app (you probably do), you'll need to also wrap your entire component tree in `<ReplexicaProvider />`:
251253

252254
```jsx
253255
// src/app/layout.tsx
@@ -365,7 +367,7 @@ You can contribute in the form of:
365367

366368
Also the special one:
367369

368-
* **Complaints** - if you're unhappy with *ANYTHING* about your current i18n approach, and you just need to vent, we're (our co-founder Max specifically) here to listen!
370+
* **Complaints** - if you're unhappy with _ANYTHING_ about your current i18n approach, and you just need to vent, we're (our co-founder Max specifically) here to listen!
369371

370372
Lastly, we've recently created a [Discord channel](https://discord.gg/GeK6AuSqzw): come say hi! 👋
371373

0 commit comments

Comments
 (0)