Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
willweimike authored Jan 11, 2025
1 parent 34c9a19 commit 82715b5
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
## Locally, Privately
Yandax Translate API / Google Translate API are all convenient to use, but people are concerned about "Privacy" since user data must be send to the remote to do the translation work

NLLBTranslateServer 100% run on your device, zero tracking

## Easy to set up
Please place the binary alongside with your model folder, **"The File and Folder Name"** must be the same as the picture

Expand All @@ -13,9 +15,9 @@ Everything is now ready 🌟
![](https://github.com/willweimike/NLLBTranslateServer/blob/main/assets/Demo.png)

## Endpoints provided by NLLBTranslateServer
- http://127.0.0.1:8080/ : Root Endpoint which accepts GET request, return current server status
- http://127.0.0.1:8080/help : Endpoint which accepts GET request, return help message (available languages for translation)
- http://127.0.0.1:8080//translate: Endpoint which accepts POST request, please contain the fields within the following picture
- http://127.0.0.1:8080/ : accept GET request, return current server status
- http://127.0.0.1:8080/help : accept GET request, return help message (available languages for translation)
- http://127.0.0.1:8080/translate: accept POST request, please contain the fields within the following picture
<img width="255" alt="image" src="https://github.com/user-attachments/assets/8ff2e29d-19d0-4cbd-b2dd-f4001543d768" />

## NLLB - No Language Left Behind
Expand Down

0 comments on commit 82715b5

Please sign in to comment.