Skip to content

Commit

Permalink
Merge #862: Update README
Browse files Browse the repository at this point in the history
e1e1071 docs: update README (Jose Celano)

Pull request description:

  Update README:

  - Fix missing line break after badgets.
  - Add roadmap draft.

ACKs for top commit:
  josecelano:
    ACK e1e1071

Tree-SHA512: d64919126564bd899ea8f513e27942a90a9d71c38f4afd020c3b60a7737416285b742176eac4ca4b39156aca88bc992f761d51d3f59c6a9904026c2fa22b0fe6
  • Loading branch information
josecelano committed May 14, 2024
2 parents 1ed2c74 + e1e1071 commit c0c107d
Showing 1 changed file with 41 additions and 1 deletion.
42 changes: 41 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Torrust Tracker

[![container_wf_b]][container_wf] [![coverage_wf_b]][coverage_wf] [![deployment_wf_b]][deployment_wf] [![testing_wf_b]][testing_wf]**Torrust Tracker** is a [BitTorrent][bittorrent] Tracker that matchmakes peers and collects statistics. Written in [Rust Language][rust] with the [Axum] web framework. _**This tracker aims to be respectful to established standards, (both [formal][BEP 00] and [otherwise][torrent_source_felid]).___
[![container_wf_b]][container_wf] [![coverage_wf_b]][coverage_wf] [![deployment_wf_b]][deployment_wf] [![testing_wf_b]][testing_wf]

**Torrust Tracker** is a [BitTorrent][bittorrent] Tracker that matchmakes peers and collects statistics. Written in [Rust Language][rust] with the [Axum] web framework. **This tracker aims to be respectful to established standards, (both [formal][BEP 00] and [otherwise][torrent_source_felid]).**

> This is a [Torrust][torrust] project and is in active development. It is community supported as well as sponsored by [Nautilus Cyberneering][nautilus].
Expand All @@ -17,6 +19,44 @@
- [x] Support [newTrackon][newtrackon] checks.
- [x] Persistent `SQLite3` or `MySQL` Databases.

## Roadmap

Persistence:

- [ ] Support other databases.

Integrations:

- [ ] Webhooks.

Administration:

- [ ] Improve categories and tag management.
- [ ] User management: list, search and ban users.
- [ ] Full-private mode.
- [ ] User statistics.

Users:

- [ ] Reset or change the password.
- [ ] User profile.
- [ ] Invitation system.
- [ ] User moderation.
- [ ] Add torrent providing only the info-hash.
- [ ] Improve search.

Torrents:

- [ ] Change the source field.
- [ ] Change the creator field.
- [ ] Implement BEP 19: WebSeed - HTTP/FTP Seeding (GetRight style).
- [ ] Implement BEP 32: BitTorrent DHT Extensions for IPv6.

Others:

- [ ] Multi-tracker
- [ ] Multi-language

## Implemented BitTorrent Enhancement Proposals (BEPs)
>
> _[Learn more about BitTorrent Enhancement Proposals][BEP 00]_
Expand Down

0 comments on commit c0c107d

Please sign in to comment.