Skip to content

Commit cb8b889

Browse files
committed
fix: linter errors in README
1 parent 61af32d commit cb8b889

File tree

1 file changed

+27
-28
lines changed

1 file changed

+27
-28
lines changed

README.md

Lines changed: 27 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
11
# Torrust Index
22

3-
[![container_wf_b]][container_wf] [![coverage_wf_b]][coverage_wf] [![deployment_wf_b]][deployment_wf] [![testing_wf_b]][testing_wf]
3+
[![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]
44

5-
__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]).___
5+
__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]).___
66

77
> This is a [Torrust][torrust] project and is in active development. It is community supported as well as sponsored by [Nautilus Cyberneering][nautilus].
88
99
## About
10-
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.
1110

12-
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.
11+
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.
12+
13+
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.
1314

1415
![Torrust Index Architecture](./docs/images/torrust-index-architecture.jpg)
1516

1617
## Key Features
17-
**
18+
1819
- [x] High Quality and Modern Rust Codebase.
1920
- [x] [Documentation][docs] Generated from Code Comments.
2021
- [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]
2526
## Getting Started
2627

2728
### Upgrading
29+
2830
If you are using `Version 1` of `torrust-tracker-backend`, please view our [upgrading guide][upgrade.md].
2931

3032
### Container Version
3133

3234
The Torrust Index is [deployed to DockerHub][dockerhub], you can run a demo immediately with the following commands:
3335

34-
#### Docker:
36+
#### Docker
3537

3638
```sh
3739
docker run -it torrust/index:develop
3840
```
41+
3942
> Please read our [container guide][containers.md] for more information.
4043
41-
#### Podman:
44+
#### Podman
4245

4346
```sh
4447
podman run -it torrust/index:develop
4548
```
49+
4650
> Please read our [container guide][containers.md] for more information.
4751
4852
### Development Version
4953

50-
- Please assure you have the ___[latest stable (or nightly) version of rust][rust]___.
51-
- Please assure that you computer has enough ram. ___Recommended 16GB.___
54+
- Please assure you have the ___[latest stable (or nightly) version of Rust][Rust]___.
55+
- Please assure that your computer has enough RAM. ___Recommended 16GB.___
5256

5357
#### Checkout, Test and Run:
5458

@@ -67,7 +71,8 @@ cargo test --tests --benches --examples --workspace --all-targets --all-features
6771
# Run the index:
6872
cargo run
6973
```
70-
#### Customization:
74+
75+
#### Customization
7176

7277
```sh
7378
# Copy the default configuration into the standard location:
@@ -88,7 +93,7 @@ _Optionally, you may choose to supply the entire configuration as an environment
8893
TORRUST_INDEX_CONFIG=$(cat "./storage/index/etc/index.toml") cargo run
8994
```
9095

91-
_For deployment you __should__ override the `tracker_api_token` by using an environmental variable:_
96+
_For deployment, you __should__ override the `tracker_api_token` by using an environmental variable:_
9297

9398
```sh
9499
# 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") \
101106
> Please view our [crate documentation][docs] for more detailed instructions.
102107
103108
### Services
109+
104110
The following services are provided by the default configuration:
105111

106112
- API
@@ -111,14 +117,15 @@ The following services are provided by the default configuration:
111117
- [API (Version 1)][api]
112118

113119
## Contributing
120+
114121
We are happy to support and welcome new people to our project. Please consider our [contributor guide][guide.md].</br>
115-
This is an open-source community supported project. We welcome contributions from the community!
122+
This is an open-source community-supported project. We welcome contributions from the community!
116123

117124
__How can you contribute?__
118125

119126
- Bug reports and feature requests.
120127
- Code contributions. You can start by looking at the issues labeled "[good first issues]".
121-
- Documentation improvements. Check the [documentation][docs] and [API documentation][api] for typos, errors, or missing information.
128+
- Documentation improvements. Check the [documentation][docs] and [API documentation][API] for typos, errors, or missing information.
122129
- Participation in the community. You can help by answering questions in the [discussions].
123130

124131
## License
@@ -138,11 +145,13 @@ Some files include explicit copyright notices and/or license notices.
138145
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.
139146

140147
## Contributor Agreement
148+
141149
The copyright of the Torrust Tracker is retained by the respective authors.
142150

143-
**Contributors agree:**
144-
- That all their contributions be granted a license(s) **compatible** with the [Torrust Trackers License](#License).
145-
- 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)*.
151+
**Contributors agree that:**
152+
153+
- All their contributions be granted a license(s) __compatible__ with the [Torrust Trackers License](#license).
154+
- 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)__.
146155

147156
**The Torrust-Tracker project has no copyright assignment agreement.**
148157

@@ -152,8 +161,6 @@ _We kindly ask you to take time and consider The Torrust Project [Contributor Ag
152161

153162
This project was a joint effort by [Nautilus Cyberneering GmbH][nautilus] and [Dutch Bits].
154163

155-
156-
157164
[container_wf]: ../../actions/workflows/container.yaml
158165
[container_wf_b]: ../../actions/workflows/container.yaml/badge.svg
159166
[coverage_wf]: ../../actions/workflows/coverage.yaml
@@ -162,11 +169,12 @@ This project was a joint effort by [Nautilus Cyberneering GmbH][nautilus] and [D
162169
[deployment_wf_b]: ../../actions/workflows/deployment.yaml/badge.svg
163170
[testing_wf]: ../../actions/workflows/testing.yaml
164171
[testing_wf_b]: ../../actions/workflows/testing.yaml/badge.svg
172+
[labels_wf]: ../../actions/workflows/labels.yaml
173+
[labels_wf_b]: ../../actions/workflows/labels.yaml/badge.svg
165174

166175
[bittorrent]: http://bittorrent.org/
167176
[rust]: https://www.rust-lang.org/
168177
[axum]: https://github.com/tokio-rs/axum
169-
[newtrackon]: https://newtrackon.com/
170178
[coverage]: https://app.codecov.io/gh/torrust/torrust-index
171179
[torrust]: https://torrust.com/
172180

@@ -178,12 +186,6 @@ This project was a joint effort by [Nautilus Cyberneering GmbH][nautilus] and [D
178186
[torrent_source_felid]: https://github.com/qbittorrent/qBittorrent/discussions/19406
179187

180188
[BEP 00]: https://www.bittorrent.org/beps/bep_0000.html
181-
[BEP 03]: https://www.bittorrent.org/beps/bep_0003.html
182-
[BEP 07]: https://www.bittorrent.org/beps/bep_0007.html
183-
[BEP 15]: https://www.bittorrent.org/beps/bep_0015.html
184-
[BEP 23]: https://www.bittorrent.org/beps/bep_0023.html
185-
[BEP 27]: https://www.bittorrent.org/beps/bep_0027.html
186-
[BEP 48]: https://www.bittorrent.org/beps/bep_0048.html
187189

188190
[containers.md]: ./docs/containers.md
189191
[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
204206

205207
[nautilus]: https://github.com/orgs/Nautilus-Cyberneering/
206208
[Dutch Bits]: https://dutchbits.nl
207-
[Naim A.]: https://github.com/naim94a/udpt
208-
[greatest-ape]: https://github.com/greatest-ape/aquatic
209-
[Power2All]: https://github.com/power2all

0 commit comments

Comments
 (0)