Skip to content

Commit 1485c4f

Browse files
committed
docs: update readme
1 parent cdb36ac commit 1485c4f

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

README.md

+17-12
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@
22

33
[![MegaLinter](https://github.com/torrust/torrust-compose/actions/workflows/mega-linter.yml/badge.svg)](https://github.com/torrust/torrust-compose/actions/workflows/mega-linter.yml)
44

5-
This repo contains different sample Docker Compose configurations for the Torrust Index.
5+
This repo contains different sample Docker Compose configurations for the [Torrust Index](https://github.com/torrust/torrust-index).
66

77
The current configurations are:
88

9-
- [`demo`](./demo/README.md): demo configuration, just to try the index.
9+
- [`demo`](./demo/README.md): demo configuration, just to try the index locally.
10+
- [`droplet`](./droplet/README.md): configuration to install the Index in a [Digital Ocean Droplet](https://www.digitalocean.com/products/droplets). It should be very similar to any virtual machine.
1011

1112
## Requirements
1213

@@ -27,16 +28,6 @@ After running the application remember the following:
2728
- Make sure you mount a volume to persist database data. That should be the default behavior, but it's better to be sure.
2829
Some configurations use a [mail catcher](https://mailcatcher.me/) container to catch emails sent by the index. You can access the mail catcher web interface at <http://localhost:1080>.
2930

30-
## Contributing
31-
32-
We welcome contributions from the community!
33-
34-
How can you contribute?
35-
36-
- Add new examples.
37-
- Bug reports and feature requests.
38-
- Code contributions. You can start by looking at the issues labeled ["good first issues"](https://github.com/torrust/torrust-compose/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
39-
4031
### MegaLinter
4132

4233
Running MegaLinter locally:
@@ -62,3 +53,17 @@ Run only one linter using the linter `Key`:
6253
```console
6354
npx mega-linter-runner -e "'ENABLE_LINTERS=JSON_PRETTIER'"
6455
```
56+
57+
## Contributing
58+
59+
We welcome contributions from the community!
60+
61+
How can you contribute?
62+
63+
- Add new examples.
64+
- Bug reports and feature requests.
65+
- Code contributions. You can start by looking at the issues labeled ["good first issues"](https://github.com/torrust/torrust-compose/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
66+
67+
## Links
68+
69+
- In the [Torrust Demo Repository](https://github.com/torrust/torrust-demo), we are tracking issues with the [Index Live Demo](https://index.torrust-demo.com/torrents) which uses the [`droplet`](./droplet/README.md) configuration in this repo.

0 commit comments

Comments
 (0)