docs: add current features for docs

[vinniimiranda]

No description provided.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[Copilot]

Pull Request Overview

This PR enriches the project documentation by adding a Features section and detailing the structure, configuration, environment setup, endpoints, and contribution workflow.

• Introduces a “Features” section with key capabilities
• Adds project structure, configuration, environment variables, and Docker instructions
• Updates Getting Started and Contributing instructions and expands Available Endpoints

Comments suppressed due to low confidence (4)

docs/README.md:18

• [nitpick] The nested list items under “Features” are indented by only two spaces, which may not render correctly in some Markdown parsers. Consider using four spaces for sub-list indentation for consistency.

  - HTTP requests

docs/README.md:85

• The Getting Started instructions reference a script ./startup.sh, but this file isn't listed in the project structure. Verify the script’s presence or update the instructions accordingly.

   ./startup.sh

docs/README.md:64

• [nitpick] Referencing environment files as .ENV/.ENV.development is unconventional; consider standardizing to lowercase .env or clarifying case sensitivity.

- `.ENV` - Default environment variables

docs/README.md:95

• [nitpick] The endpoint GET /api/hellos may be a typo or inconsistent with other routes. Confirm the correct path or update it for consistency.

- `GET /api/hellos` - Example endpoint