Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hippalus committed Aug 20, 2024
1 parent 9514e83 commit 78e305f
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,13 @@ it [here](https://en.wikipedia.org/wiki/Umay).
Umay can be configured using TOML files and environment variables. See `config.rs` for available options.

## Quick Start

To quickly run and test Umay using Docker Compose:

- Ensure you have Docker and Docker Compose installed.
- Clone this repository and navigate to the project directory.
- Start the services:

```bash
docker-compose up --build
```
Expand All @@ -38,9 +40,11 @@ openssl s_client -connect localhost:9994
If working correctly, you should see a TLS handshake followed by an echo response from one of the backend servers.

To stop the services:

```bash
docker-compose down
```

## Development Status

This project is under active development and is considered experimental. Use in production environments is not
Expand Down

0 comments on commit 78e305f

Please sign in to comment.