Skip to content

Commit 1d4e215

Browse files
committed
docs: improve README with missing workflow badges, license section, and links
1 parent c09a86a commit 1d4e215

1 file changed

Lines changed: 21 additions & 9 deletions

File tree

README.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,20 @@
33
[![E2E Infrastructure Tests](https://github.com/torrust/torrust-tracker-deployer/actions/workflows/test-e2e-infrastructure.yml/badge.svg)](https://github.com/torrust/torrust-tracker-deployer/actions/workflows/test-e2e-infrastructure.yml)
44
[![E2E Deployment Tests](https://github.com/torrust/torrust-tracker-deployer/actions/workflows/test-e2e-deployment.yml/badge.svg)](https://github.com/torrust/torrust-tracker-deployer/actions/workflows/test-e2e-deployment.yml)
55
[![Coverage](https://github.com/torrust/torrust-tracker-deployer/actions/workflows/coverage.yml/badge.svg)](https://github.com/torrust/torrust-tracker-deployer/actions/workflows/coverage.yml)
6+
[![SDK Examples Tests](https://github.com/torrust/torrust-tracker-deployer/actions/workflows/test-sdk-examples.yml/badge.svg)](https://github.com/torrust/torrust-tracker-deployer/actions/workflows/test-sdk-examples.yml)
7+
[![Test LXD Container Provisioning](https://github.com/torrust/torrust-tracker-deployer/actions/workflows/test-lxd-provision.yml/badge.svg)](https://github.com/torrust/torrust-tracker-deployer/actions/workflows/test-lxd-provision.yml)
8+
[![Test Dependency Installer](https://github.com/torrust/torrust-tracker-deployer/actions/workflows/test-dependency-installer.yml/badge.svg)](https://github.com/torrust/torrust-tracker-deployer/actions/workflows/test-dependency-installer.yml)
9+
[![Cargo Security Audit](https://github.com/torrust/torrust-tracker-deployer/actions/workflows/cargo-security-audit.yml/badge.svg)](https://github.com/torrust/torrust-tracker-deployer/actions/workflows/cargo-security-audit.yml)
10+
[![Docker Security Scan](https://github.com/torrust/torrust-tracker-deployer/actions/workflows/docker-security-scan.yml/badge.svg)](https://github.com/torrust/torrust-tracker-deployer/actions/workflows/docker-security-scan.yml)
11+
[![Container](https://github.com/torrust/torrust-tracker-deployer/actions/workflows/container.yaml/badge.svg)](https://github.com/torrust/torrust-tracker-deployer/actions/workflows/container.yaml)
12+
[![Backup Container](https://github.com/torrust/torrust-tracker-deployer/actions/workflows/backup-container.yaml/badge.svg)](https://github.com/torrust/torrust-tracker-deployer/actions/workflows/backup-container.yaml)
13+
[![Code Statistics](https://github.com/torrust/torrust-tracker-deployer/actions/workflows/code-statistics.yml/badge.svg)](https://github.com/torrust/torrust-tracker-deployer/actions/workflows/code-statistics.yml)
614

715
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/torrust/torrust-tracker-deployer?quickstart=1)
816

917
# Torrust Tracker Deployer
1018

11-
Deployment automation for Torrust Tracker environments using OpenTofu, Ansible, and Rust.
19+
Deployment automation for [Torrust Tracker](https://github.com/torrust/torrust-tracker) environments using [OpenTofu](https://opentofu.org), [Ansible](https://www.ansible.com), and [Rust](https://www.rust-lang.org).
1220

1321
## Release Status
1422

@@ -73,8 +81,8 @@ cargo run -- destroy my-environment
7381

7482
Important:
7583

76-
- Keep your environment JSON files in envs.
77-
- The data directory is application-managed deployment state and should not be edited manually.
84+
- Keep your environment JSON files in [`envs/`](envs/).
85+
- The [`data/`](data/) directory is application-managed deployment state and should not be edited manually.
7886

7987
## Docker Usage
8088

@@ -136,15 +144,19 @@ For example application operations and maintenance after deployment, see:
136144

137145
Top-level directories:
138146

139-
- src: Rust codebase using DDD layers (domain, application, infrastructure, presentation)
140-
- templates: OpenTofu and Ansible templates
141-
- docs: user and contributor documentation
142-
- envs: user environment configuration files (git-ignored)
143-
- build: generated runtime files (git-ignored)
144-
- data: application-managed deployment state
147+
- [`src/`](src/): Rust codebase using DDD layers (domain, application, infrastructure, presentation)
148+
- [`templates/`](templates/): OpenTofu and Ansible templates
149+
- [`docs/`](docs/README.md): user and contributor documentation
150+
- [`envs/`](envs/): user environment configuration files (git-ignored)
151+
- `build/`: generated runtime files (git-ignored)
152+
- [`data/`](data/): application-managed deployment state
145153

146154
## Roadmap After 0.1.0
147155

148156
The 0.1.0 line establishes the functional baseline. Upcoming improvements are tracked in the roadmap, including broader provider support and deployment UX refinements.
149157

150158
See: [Roadmap](docs/roadmap.md)
159+
160+
## License
161+
162+
This project is licensed under the [MIT License](LICENSE).

0 commit comments

Comments
 (0)