Skip to content

Commit 1b74788

Browse files
authored
refactor: add README for demo and acknowledgments (#10)
2 parents aebea64 + f3867f1 commit 1b74788

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,14 @@ A **React** component for **local, secure, on-demand translations** powered by t
2323

2424
---
2525

26+
## Demo
27+
28+
Check out a live demo here: **[https://ai-translation-demo-three.vercel.app/](https://ai-translation-demo-three.vercel.app/)**
29+
30+
The example code used for this demo is available in this repository: **[joelshejar/ai-translation-demo](https://github.com/joelshejar/ai-translation-demo)**
31+
32+
---
33+
2634
## Features
2735

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

159167
---
160168

169+
## Acknowledgments
170+
171+
We took the base setup for this starter package from [TimMikeladze/typescript-react-package-starter](https://github.com/TimMikeladze/typescript-react-package-starter).
172+
173+
174+
---
161175
# License
162176

163177
This project is licensed under the [MIT License](./LICENSE).

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@codethicket/react-ai-translator",
33
"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.",
4-
"version": "0.1.0",
4+
"version": "0.1.1",
55
"author": "Joel Rajesh",
66
"license": "MIT",
77
"keywords": ["translations", "ai", "react", "i18n"],

0 commit comments

Comments
 (0)