Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
hugocxl committed Jun 7, 2024
1 parent 22d7be7 commit a2cd6d7
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img src="media/cover.png" width="100%" align="center" />
<img src="media/cover.png" width="100%" align="center" alt="cover" style="border-radius:16px" />

<br />

Expand All @@ -12,7 +12,7 @@
</div>

<div align="center">
<b>Terai is a modern localization framework for Javascript. Built with the open source community and optimized for developer experience in the frameworks you love.</b>
<b>Terai is a i18n localization framework for Typescript applications. Built for the open source community and optimized for developer experience in the frameworks you love.</b>
</div>

<div align="center">
Expand Down Expand Up @@ -55,32 +55,34 @@ Workflow can be broken down into 3 steps:

More documentation available at [https://terai-labs.github.io/terai](https://terai-labs.github.io/terai).

## Quick Demo

<img src="media/demo.gif" width="100%" align="center" alt="demo" style="border-radius:16px" />

## Features

- πŸš€ **Speed**: Remove the pain in the localization process. Translate your products **10x faster**.
- πŸ§‘β€πŸ’» **Developer-focused**: One of our main goal was improving the developer experience. No more looking for keys in your source code, no more editing localisation files, and no more manual exporting data for translators.
- πŸ† **Javascript-based**: designed to be used in any javascript-based environment with specific integrations for all major frameworks: Node, React, Next, Vite...
- πŸ€– **AI Translation**: Let the machines work for you. We natively support ChatGPT, Google Translate, and AWS translate (and more to come).
- ⌨️ **CLI**: Use your terminal with the CLI.
- πŸ† **Javascript-based**: designed to be used in any javascript-based environment with specific integrations for all major frameworks: Node, React, Next...
- πŸ€– **Translation**: Let the machines work for you. We natively support ChatGPT, Google Translate (and more to come), or use your custom translation service.
- πŸ•‹ **Cache**: Don’t translate the same string twice. Translation cache reuses strings you’ve already translated.
- 🌱 **Lightweight**: offer your product to your audience in the way they understand better with just a few KB.
- βœ‚οΈ **Code splitting**: Split your translation files with ease. Just import the messages your user needs to see.
- πŸ™ **GIT**: Use your well-known version-control systems for storing translations.
- πŸ’Ž **TypeScript**: Full-written in TypeScript.
- ⭐️ **MIT Licensed**: Free for personal and commercial use.

## Packages

| Package | Description | Version | Size | Downloads |
| :------ | :---- | :-----: | :--: | :-------: |
| `@terai/dev` | The user-facing package for **Terai** | [![Version](https://img.shields.io/npm/v/@terai/dev.svg?logo=npm)](https://www.npmjs.com/package/@terai/dev) | [![Size](https://img.shields.io/bundlephobia/minzip/@terai/dev)](https://bundlephobia.com/result?p=@terai/dev) | [![NPM](https://img.shields.io/npm/dm/@terai/dev.svg?&logo=npm)](https://www.npmjs.com/package/@terai/dev) |
| `@terai/dev` | Dev package for **Terai** | [![Version](https://img.shields.io/npm/v/@terai/dev.svg?logo=npm)](https://www.npmjs.com/package/@terai/dev) | [![Size](https://img.shields.io/bundlephobia/minzip/@terai/dev)](https://bundlephobia.com/result?p=@terai/dev) | [![NPM](https://img.shields.io/npm/dm/@terai/dev.svg?&logo=npm)](https://www.npmjs.com/package/@terai/dev) |
| `@terai/react` | **Terai** for React.js | [![Version](https://img.shields.io/npm/v/@terai/react.svg?logo=npm)](https://www.npmjs.com/package/@terai/react) | [![Size](https://img.shields.io/bundlephobia/minzip/@terai/react)](https://bundlephobia.com/result?p=@terai/react) | [![NPM](https://img.shields.io/npm/dm/@terai/react.svg?&logo=npm)](https://www.npmjs.com/package/@terai/react) |
| `@terai/next` | **Terai** for Next.js (WIP) | [![Version](https://img.shields.io/npm/v/@terai/next.svg?logo=npm)](https://www.npmjs.com/package/@terai/next) | [![Size](https://img.shields.io/bundlephobia/minzip/@terai/next)](https://bundlephobia.com/result?p=@terai/next) | [![NPM](https://img.shields.io/npm/dm/@terai/next.svg?&logo=npm)](https://www.npmjs.com/package/@terai/next) |
| `@terai/node` | **Terai** for Node.js | [![Version](https://img.shields.io/npm/v/@terai/node.svg?logo=npm)](https://www.npmjs.com/package/@terai/node) | [![Size](https://img.shields.io/bundlephobia/minzip/@terai/node)](https://bundlephobia.com/result?p=@terai/node) | [![NPM](https://img.shields.io/npm/dm/@terai/node.svg?&logo=npm)](https://www.npmjs.com/package/@terai/node) |

## Getting Started

Visit <a aria-label="terai learn" href="https://terai-labs.github.io/terai/learn">https://terai-labs.github.io/terai/learn</a> to get started with **Terai**.
Visit <a aria-label="terai learn" href="https://terai-labs.github.io/terai">https://terai-labs.github.io/terai</a> to get started with **Terai**.

## Documentation

Expand Down
Binary file added media/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a2cd6d7

Please sign in to comment.