Skip to content
This repository was archived by the owner on Jun 22, 2023. It is now read-only.

Commit 55d415d

Browse files
committed
updated readme and index
1 parent 27d092c commit 55d415d

File tree

9 files changed

+16
-26
lines changed

9 files changed

+16
-26
lines changed

README.md

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,13 @@
11
# Torrust Documentation
22

33
## Introduction
4-
Torrust is an open source project that brings you all the tools you need to host your own (private) online torrent database.
4+
Torrust is an open source project that brings you all the tools you need to host your own (private) BitTorrent tracker and online torrent index.
55

66
### Project structure
7-
Torrust is split up into three separate applications.
8-
9-
- [__Torrust Backend__](https://github.com/torrust/torrust-web-backend): A REST API written in Rust with the Actix web framework that acts as a backend for the Torrust Frontend.
10-
- [__Torrust Frontend__](https://github.com/torrust/torrust-web-frontend): A Vue application where torrents can be uploaded and downloaded.
11-
- [__Torrust Tracker__](https://github.com/torrust/torrust-tracker): A UDP based torrent tracker built with Rust.
12-
13-
### Features
14-
- [X] Email / Password authentication
15-
- [X] Self-hosted Private Tracker
16-
- [X] Torrent Uploading / Downloading
17-
- [X] No external services needed
18-
- [X] Completely written in Rust
19-
20-
### Screenshots
21-
![Web UI Category page](docs/img/web-ui.png)
22-
![Web UI Torrent page](docs/img/web-ui-torrent.png)
7+
Torrust is split up into two separate applications.
8+
9+
- [__Torrust Tracker__](https://github.com/torrust/torrust-tracker): A torrent indexing website that depends on the Torrust tracker.
10+
- [__Torrust Index__](https://github.com/torrust/torrust): A lightweight but incredibly powerful and feature-rich (private) BitTorrent Tracker.
2311

2412
# Installation
2513

docs/img/popular.png

238 KB
Loading

docs/img/settings.png

261 KB
Loading

docs/img/signup.png

316 KB
Loading

docs/img/torrent.png

286 KB
Loading

docs/img/upload.png

206 KB
Loading

docs/img/web-ui-torrent.png

-358 KB
Binary file not shown.

docs/img/web-ui.png

-92.9 KB
Binary file not shown.

docs/index.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,27 @@
11
# About
22

33
## Introduction
4-
Torrust is an open source project that brings you all the tools you need to host your own (private) online torrent database.
4+
Torrust is an open source project that brings you all the tools you need to host your own (private) BitTorrent tracker and online torrent index.
55

66
## Project structure
7-
Torrust is split up into three separate applications.
7+
Torrust is split up into two separate applications.
88

9-
- [__Torrust Backend__](https://github.com/torrust/torrust-web-backend): A REST API written in Rust with the Actix web framework that acts as a backend for the Torrust Frontend.
10-
- [__Torrust Frontend__](https://github.com/torrust/torrust-web-frontend): A Vue application where torrents can be uploaded and downloaded.
11-
- [__Torrust Tracker__](https://github.com/torrust/torrust-tracker): A UDP based torrent tracker built with Rust.
9+
- [__Torrust Tracker__](https://github.com/torrust/torrust-tracker): A lightweight but incredibly powerful and feature-rich (private) BitTorrent Tracker.
10+
- [__Torrust Index__](https://github.com/torrust/torrust): A torrent indexing website that depends on the Torrust tracker.
1211

1312
## Features
14-
- [X] Email / Password authentication
15-
- [X] Self-hosted Private Tracker
13+
- [X] Email / Password authentication (optional email verification)
14+
- [X] Self-hosted BitTorrent tracker with Private and Whitelist support and a built-in API
1615
- [X] Torrent Uploading / Downloading
1716
- [X] No external services needed
1817
- [X] Completely written in Rust
1918

2019
## Screenshots
21-
![Web UI Category page](img/web-ui.png)
22-
![Web UI Torrent page](img/web-ui-torrent.png)
20+
![Web UI Sign Up page](img/signup.png)
21+
![Web UI Popular page](img/popular.png)
22+
![Web UI Torrent page](img/torrent.png)
23+
![Web UI Upload page](img/upload.png)
24+
![Web UI Settings page](img/settings.png)
2325

2426
## Contributing
2527
Please report any bugs you find to our issue tracker. Ideas and feature requests are welcome as well!

0 commit comments

Comments
 (0)