Skip to content

Commit ec52713

Browse files
committed
docs: minimise and cleanup readme file
1 parent 508f5cf commit ec52713

File tree

1 file changed

+13
-54
lines changed

1 file changed

+13
-54
lines changed

README.md

Lines changed: 13 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,24 @@
11
# Torrust Index Backend
22

3-
![README HEADER](./img/Torrust_Repo_BackEnd_Readme_Header-20220615.jpg)
3+
This repository serves as the backend for the [Torrust Index](https://github.com/torrust/torrust-index) project, that implements the [Torrust Index Application Interface](https://github.com/torrust/torrust-index-api-lib).
44

5-
![Open Source](https://badgen.net/badge/Open%20Source/100%25/DA2CE7)
6-
![Cool](https://badgen.net/badge/Cool/100%25/FF7F50)
7-
8-
![Nautilus Sponsored](https://badgen.net/badge/Sponsor/Nautilus%20Cyberneering/red)
9-
10-
---
11-
12-
## 📢Important Updates 📢
13-
14-
- None at the moment [ACCESS ALL UPDATES](https://github.com/torrust/torrust-index-backend/wiki/Project-Updates)
15-
16-
---
17-
18-
## Index
19-
20-
- [PROJECT DESCRIPTION](#project-description)
21-
- [PROJECT ROADMAP](#project_roadmap)
22-
- [DOCUMENTATION](#documentation)
23-
- [INSTALLATION](#installation)
24-
- [CONTACT & CONTRIBUTING](#contact_and_contributing)
25-
- [CREDITS](#credits)
26-
27-
## Project Description
28-
29-
This repository serves as the backend for the [Torrust Index](https://github.com/torrust/torrust-index) project.
30-
31-
### Roadmap
32-
33-
*Coming soon.*
5+
We also provide the [Torrust Index Frontend](https://github.com/torrust/torrust-index-frontend) project, that is our reference web-application that consumes the API provided here.
346

357
## Documentation
368

37-
You can read the documentation [here](https://torrust.com/torrust-index/install/#installing-the-backend).
9+
You can read the Torrust Index documentation [here](https://torrust.com/torrust-index/install/#installing-the-backend).
3810

3911
## Installation
4012

41-
1. Install prerequisites:
42-
43-
- [Rust/Cargo](https://www.rust-lang.org/) - Compiler toolchain & Package Manager (cargo).
13+
1. Setup [Rust / Cargo](https://www.rust-lang.org/) in your Environment.
4414

45-
2. Clone the repository:
46-
47-
```bash
48-
git clone https://github.com/torrust/torrust-index-backend.git
49-
```
15+
2. Clone this repo.
5016

51-
3. Open the project directory and create a file called: `.env`:
17+
3. Set the database connection URI in the projects `/.env` file:
5218

5319
```bash
5420
cd torrust-index-backend
55-
echo "DATABASE_URL=sqlite://data.db?mode=rwc" > .env
21+
echo "DATABASE_URL=sqlite://data.db?mode=rwc" >> .env
5622
```
5723

5824
4. Install sqlx-cli and build the sqlite database:
@@ -74,11 +40,9 @@ You can read the documentation [here](https://torrust.com/torrust-index/install/
7440
./target/release/torrust-index-backend
7541
```
7642

77-
7. Edit the newly generated `config.toml` file ([config.toml documentation](https://torrust.github.io/torrust-tracker/CONFIG.html)):
43+
7. Review and edit the default `/config.toml` file.
7844

79-
```bash
80-
nano config.toml
81-
```
45+
> _Please view the [configuration documentation](https://torrust.github.io/torrust-tracker/CONFIG.html)._
8246

8347
8. Run the backend again:
8448

@@ -88,17 +52,12 @@ You can read the documentation [here](https://torrust.com/torrust-index/install/
8852

8953
## Contact and Contributing
9054

91-
Feel free to contact us via:
92-
93-
Message `Warm Beer#3352` on Discord or email `[email protected]`.
94-
95-
or
96-
97-
Please make suggestions and report any **Torrust Index Back End** specific bugs you find to the issue tracker of this repository [here](https://github.com/torrust/torrust-index-backend/issues)
55+
Please consider the [Torrust Contribution Guide](https://github.com/torrust/.github/blob/main/info/contributing.md).
9856

99-
**Torrust Index Front End** specific issues can be submitted [here](https://github.com/torrust/torrust-index-frontend/issues).
57+
Please report issues:
10058

101-
Universal issues with the **Torrust Index** can be submitted [here](https://github.com/torrust/torrust-index/issues). Ideas and feature requests are welcome as well!
59+
* Torrust Index Backend specifically: [here](https://github.com/torrust/torrust-index-backend/issues).
60+
* Torrust Index in general: [here](https://github.com/torrust/torrust-index/issues).
10261

10362
---
10463

0 commit comments

Comments
 (0)