Skip to content

Commit

Permalink
docs: improve readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
samk-dev committed Dec 8, 2023
1 parent afcc400 commit b217c9d
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]

[![temp-Image4v-TX6-F.jpg](https://i.postimg.cc/jqn4w5y1/temp-Image4v-TX6-F.jpg)](https://postimg.cc/3W7vz3Sj)

Simple and easy to use translation manager for `nuxt` and `nuxt-i18n` that allows to manage translations from a single CSV file.

- [ Release Notes](/CHANGELOG.md)
Expand Down Expand Up @@ -53,8 +55,32 @@ login,"Login","Acceder","Accedir"' > path-to-your-langDir/translations.csv
# replace `path-to-your-langDir`
```

This will generate a CSV file that looks like this:

| Key | en-US | fr | de |
|---------|----------------|------------|-----------------|
| hello | Hello | Bonjour | Hallo |
| goodbye | Goodbye | Au revoir | Auf Wiedersehen |
| thanks | Thanks | Merci | Danke |

**Be sure to use the format** `lang-code` in the header row e.g. `es-ES`

**Be sure to set the delimiter to comma in your csv editor** `,`

✨ Tip: you can use [Edit CSV Extension for VSCode](https://marketplace.visualstudio.com/items?itemName=janisdd.vscode-edit-csv) to manage your csv file inside of `vscode`

<details>
<summary>View raw csv code</summary>

```csv
Key,"English, en-US","French, fr","German, de"
hello,"Hello","Bonjour","Hallo"
goodbye,"Goodbye","Au revoir","Auf Wiedersehen"
thanks,"Thanks","Merci","Danke"
```

</details>

## Options

```ts
Expand Down

0 comments on commit b217c9d

Please sign in to comment.