Skip to content

Commit 2627a12

Browse files
committed
Update README.md
1 parent 3345131 commit 2627a12

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![License](https://img.shields.io/badge/license-Custom-lightgrey.svg)](LICENSE)
55
[![GitHub stars](https://img.shields.io/github/stars/codeSamuraii/transit.sh.svg?style=social&label=Star&maxAge=2592000)](https://github.com/codeSamuraii/transit.sh/stargazers/)
66

7-
**Transit.sh** enables direct, peer-to-peer file transfers without intermediary storage. Files are streamed from sender to receiver in chunks, leveraging WebSockets and HTTP.
7+
**Transit.sh** enables direct, client-to-client file transfers without intermediary storage. Files are streamed from sender to receiver in real time. It leverages Redis, WebSockets and FastAPI for a modern, scalable architecture.
88

99
> **Service Status:** The public instance at [https://transit.sh](https://transit.sh) is a proof-of-concept deployment. While functional, it comes with no service guarantees.
1010
@@ -80,10 +80,10 @@ python -u app.py
8080

8181
For deployment:
8282
```bash
83-
python -m uvicorn app:app --host 0.0.0.0 --port 8080
83+
uvicorn app:app --host 0.0.0.0 --port 8080
8484
```
8585

86-
> **Note:** While the API works with multiple workers, it hasn't been fully tested in a multi-worker setup.
86+
> **Note:** The API supports multiple workers on different machines as long as the Redis cache is accessible on all of them, ideally with low latency. Accessing Redis over the internet would drastically reduce transfers speeds.
8787

8888
## Contributing
8989

0 commit comments

Comments
 (0)