Skip to content

refactor: add README for demo and acknowledgments #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 5, 2025
Merged

refactor: add README for demo and acknowledgments #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,14 @@ A **React** component for **local, secure, on-demand translations** powered by t

---

## Demo

Check out a live demo here: **[https://ai-translation-demo-three.vercel.app/](https://ai-translation-demo-three.vercel.app/)**

The example code used for this demo is available in this repository: **[joelshejar/ai-translation-demo](https://github.com/joelshejar/ai-translation-demo)**

---

## Features

- **Secure & Local**: Utilizes your device’s GPU, keeping all data local.
Expand Down Expand Up @@ -158,6 +166,12 @@ We’ll review your submission and work together to make **react-ai-translator**

---

## Acknowledgments

We took the base setup for this starter package from [TimMikeladze/typescript-react-package-starter](https://github.com/TimMikeladze/typescript-react-package-starter).


---
# License

This project is licensed under the [MIT License](./LICENSE).
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@codethicket/react-ai-translator",
"description": "A React component for local, secure, on-demand translations powered by the Xenova/nllb-200-distilled-600M model. This package utilizes the WebGPU capabilities of the device on which the app runs, ensuring data privacy and enabling you to translate text without sending data to third-party APIs.",
"version": "0.1.0",
"version": "0.1.1",
"author": "Joel Rajesh",
"license": "MIT",
"keywords": ["translations", "ai", "react", "i18n"],
Expand Down
Loading