diff --git a/README.md b/README.md index c1a9b10c..ef16a9e0 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,21 @@ # Torrust Index -[![container_wf_b]][container_wf] [![coverage_wf_b]][coverage_wf] [![deployment_wf_b]][deployment_wf] [![testing_wf_b]][testing_wf] +[![container_wf_b]][container_wf] [![coverage_wf_b]][coverage_wf] [![deployment_wf_b]][deployment_wf] [![testing_wf_b]][testing_wf] [![labels_wf_b]][labels_wf] -__Torrust Index__, is a library for [BitTorrent][bittorrent] Files. Written in [Rust Language][rust] with the [axum] web framework. ___This index aims to be respectful to established standards, (both [formal][BEP 00] and [otherwise][torrent_source_felid]).___ +__Torrust Index__ is a library for [BitTorrent][bittorrent] Files. Written in [Rust Language][rust] with the [Axum] web framework. ___This index 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]. ## About -The core purpose of a [BitTorrent][bittorrent] Index is to maintain a database that connects torrent files with useful metadata. Allowing a community of users to keep track their torrents in a well organized and informative manner. -The __Torrust Index__ serves a [high-level api][api] for our [Torrust Index GUI][gui] client. It also connects to the [management api][api_tracker] of our [Torrust Tracker][tracker], to provide statistic and whitelisting functionally. +The core purpose of a [BitTorrent][bittorrent] Index is to maintain a database that connects torrent files with useful metadata. Allowing a community of users to keep track of their torrents in a well-organized and informative manner. + +The __Torrust Index__ serves as a [high-level API][API] for our [Torrust Index GUI][gui] client. It also connects to the [management api][api_tracker] of our [Torrust Tracker][tracker], to provide statistics and whitelisting functionally. ![Torrust Index Architecture](./docs/images/torrust-index-architecture.jpg) ## Key Features -** + - [x] High Quality and Modern Rust Codebase. - [x] [Documentation][docs] Generated from Code Comments. - [x] [Comprehensive Suit][coverage] of Unit and Functional Tests. @@ -25,30 +26,33 @@ The __Torrust Index__ serves a [high-level api][api] for our [Torrust Index GUI] ## Getting Started ### Upgrading + If you are using `Version 1` of `torrust-tracker-backend`, please view our [upgrading guide][upgrade.md]. ### Container Version The Torrust Index is [deployed to DockerHub][dockerhub], you can run a demo immediately with the following commands: -#### Docker: +#### Docker ```sh docker run -it torrust/index:develop ``` + > Please read our [container guide][containers.md] for more information. -#### Podman: +#### Podman ```sh podman run -it torrust/index:develop ``` + > Please read our [container guide][containers.md] for more information. ### Development Version -- Please assure you have the ___[latest stable (or nightly) version of rust][rust]___. -- Please assure that you computer has enough ram. ___Recommended 16GB.___ +- Please assure you have the ___[latest stable (or nightly) version of Rust][Rust]___. +- Please assure that your computer has enough RAM. ___Recommended 16GB.___ #### Checkout, Test and Run: @@ -67,7 +71,8 @@ cargo test --tests --benches --examples --workspace --all-targets --all-features # Run the index: cargo run ``` -#### Customization: + +#### Customization ```sh # Copy the default configuration into the standard location: @@ -88,7 +93,7 @@ _Optionally, you may choose to supply the entire configuration as an environment TORRUST_INDEX_CONFIG=$(cat "./storage/index/etc/index.toml") cargo run ``` -_For deployment you __should__ override the `tracker_api_token` by using an environmental variable:_ +_For deployment, you __should__ override the `tracker_api_token` by using an environmental variable:_ ```sh # Please use the secret that you generated for the torrust-tracker configuration. @@ -101,6 +106,7 @@ TORRUST_INDEX_CONFIG=$(cat "./storage/index/etc/index.toml") \ > Please view our [crate documentation][docs] for more detailed instructions. ### Services + The following services are provided by the default configuration: - API @@ -111,14 +117,15 @@ The following services are provided by the default configuration: - [API (Version 1)][api] ## Contributing + We are happy to support and welcome new people to our project. Please consider our [contributor guide][guide.md].
-This is an open-source community supported project. We welcome contributions from the community! +This is an open-source community-supported project. We welcome contributions from the community! __How can you contribute?__ - Bug reports and feature requests. - Code contributions. You can start by looking at the issues labeled "[good first issues]". -- Documentation improvements. Check the [documentation][docs] and [API documentation][api] for typos, errors, or missing information. +- Documentation improvements. Check the [documentation][docs] and [API documentation][API] for typos, errors, or missing information. - Participation in the community. You can help by answering questions in the [discussions]. ## License @@ -138,11 +145,13 @@ Some files include explicit copyright notices and/or license notices. For prosperity, versions of Torrust Tracker that are older than five years are automatically granted the [MIT-0][MIT_0] license in addition to the existing [AGPL-3.0-only][AGPL_3_0] license. ## Contributor Agreement + The copyright of the Torrust Tracker is retained by the respective authors. -**Contributors agree:** -- That all their contributions be granted a license(s) **compatible** with the [Torrust Trackers License](#License). -- That all contributors signal **clearly** and **explicitly** any other compilable licenses if they are not: *[AGPL-3.0-only with the legacy MIT-0 exception](#License)*. +**Contributors agree that:** + +- All their contributions be granted a license(s) __compatible__ with the [Torrust Trackers License](#license). +- All contributors signal __clearly__ and __explicitly__ any other compilable licenses if they are not: __[AGPL-3.0-only with the legacy MIT-0 exception](#license)__. **The Torrust-Tracker project has no copyright assignment agreement.** @@ -152,8 +161,6 @@ _We kindly ask you to take time and consider The Torrust Project [Contributor Ag This project was a joint effort by [Nautilus Cyberneering GmbH][nautilus] and [Dutch Bits]. - - [container_wf]: ../../actions/workflows/container.yaml [container_wf_b]: ../../actions/workflows/container.yaml/badge.svg [coverage_wf]: ../../actions/workflows/coverage.yaml @@ -162,11 +169,12 @@ This project was a joint effort by [Nautilus Cyberneering GmbH][nautilus] and [D [deployment_wf_b]: ../../actions/workflows/deployment.yaml/badge.svg [testing_wf]: ../../actions/workflows/testing.yaml [testing_wf_b]: ../../actions/workflows/testing.yaml/badge.svg +[labels_wf]: ../../actions/workflows/labels.yaml +[labels_wf_b]: ../../actions/workflows/labels.yaml/badge.svg [bittorrent]: http://bittorrent.org/ [rust]: https://www.rust-lang.org/ [axum]: https://github.com/tokio-rs/axum -[newtrackon]: https://newtrackon.com/ [coverage]: https://app.codecov.io/gh/torrust/torrust-index [torrust]: https://torrust.com/ @@ -178,12 +186,6 @@ This project was a joint effort by [Nautilus Cyberneering GmbH][nautilus] and [D [torrent_source_felid]: https://github.com/qbittorrent/qBittorrent/discussions/19406 [BEP 00]: https://www.bittorrent.org/beps/bep_0000.html -[BEP 03]: https://www.bittorrent.org/beps/bep_0003.html -[BEP 07]: https://www.bittorrent.org/beps/bep_0007.html -[BEP 15]: https://www.bittorrent.org/beps/bep_0015.html -[BEP 23]: https://www.bittorrent.org/beps/bep_0023.html -[BEP 27]: https://www.bittorrent.org/beps/bep_0027.html -[BEP 48]: https://www.bittorrent.org/beps/bep_0048.html [containers.md]: ./docs/containers.md [upgrade.md]: ./upgrades/from_v1_0_0_to_v2_0_0/README.md @@ -204,6 +206,3 @@ This project was a joint effort by [Nautilus Cyberneering GmbH][nautilus] and [D [nautilus]: https://github.com/orgs/Nautilus-Cyberneering/ [Dutch Bits]: https://dutchbits.nl -[Naim A.]: https://github.com/naim94a/udpt -[greatest-ape]: https://github.com/greatest-ape/aquatic -[Power2All]: https://github.com/power2all