Skip to content

Commit

Permalink
docs: added Codesandbox example
Browse files Browse the repository at this point in the history
  • Loading branch information
samk-dev committed Apr 5, 2024
1 parent ea804b4 commit ac6b64d
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
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)
<!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/nuxt-translation-manager?file=playground%2Fapp.vue) -->
<!-- - [📖 &nbsp;Documentation](https://example.com) -->
- [🏀 Online playground](https://codesandbox.io/p/github/samk-dev/nuxt-translation-manager-module-usage-example/main)
- [🐱 Playground repository](https://github.com/samk-dev/nuxt-translation-manager-module-usage-example)

## Features

Expand All @@ -26,6 +26,18 @@ Simple and easy to use translation manager for `nuxt` and `nuxt-i18n` that allow
npx nuxi@latest module add translation-manager
```

## Manual Installation

1. Add `nuxt-translation-manager` dependency to your project

```bash
npm install -D nuxt-translation-manager

pnpm install -D nuxt-translation-manager

yarn add -D nuxt-translation-manager
```

2. Add `nuxt-translation-manager` to the `modules` section of `nuxt.config.ts`

```js
Expand Down Expand Up @@ -134,11 +146,6 @@ pnpm run release

Inspired by [Quasalang CLI](https://github.com/dannyconnell/quasalang) by [Danny Connell](https://github.com/dannyconnell)

## TODO

- [] Generate a template for translations.csv file instead of creating it manually
- [] Add a GUI manager to Nuxt Devtools

<!-- Badges -->
[npm-version-src]: https://img.shields.io/npm/v/nuxt-translation-manager/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/nuxt-translation-manager
Expand Down

0 comments on commit ac6b64d

Please sign in to comment.