Skip to content

Commit 0b5f0bb

Browse files
Add Sidecar details into the README file
1 parent c9b0bc9 commit 0b5f0bb

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Todo API is a simple RESTful service for managing a to-do list, allowing users t
44

55
## Prerequisites
66

7-
- [Docker](https://www.docker.com/get-started)
7+
- [Docker](https://www.docker.com/get-started)
88
- [Docker Compose](https://docs.docker.com/compose/)
99

1010
## Quick Start
@@ -73,3 +73,15 @@ python app/main.py
7373
```
7474

7575
The API will read the configuration from `auth_config.yml`. If the file doesn't exist, it will default to no authentication.
76+
77+
## Sidecar Usage
78+
79+
The application is containerized and exposes port `8000`, making it suitable for use as a sidecar in various deployment scenarios.
80+
81+
The Docker container exposes port `8000`, allowing the API to be accessed from other containers or services in the same network.
82+
83+
- **For PR testing**: `ghcr.io/codesignal/learn_todo-api:<pr-number>`
84+
- Example: `ghcr.io/codesignal/learn_todo-api:pr-8`
85+
- **For main branch**: `ghcr.io/codesignal/learn_todo-api:latest`
86+
87+
The sidecar can be used in base tasks and other containerized environments where you need a todo API service.

0 commit comments

Comments
 (0)