diff --git a/README.md b/README.md index a1d092b..6afb6f5 100644 --- a/README.md +++ b/README.md @@ -15,10 +15,20 @@ The application inside this container reads its configuration from a single envi ### Required Environment Variable - **DB_URL**: PostgreSQL connection string (e.g., `postgresql://user:password@host:port/dbname`) -## Run +## 1. Run the server To run the Jaro application, use the following command, replacing the `DB_URL` with your actual PostgreSQL connection string: ``` -docker run -e DB_URL=postgresql://user:password@host:port/dbname -p 8008:8008 abdealijaroli/jaro:latest +docker run -d --name jaro -e DB_URL=postgresql://user:password@host:port/dbname -p 8008:8008 abdealijaroli/jaro:latest +``` + +## 2. Shorten a link +``` +docker run -d --name jaro -e DB_URL=postgresql://user:password@host:port/dbname -p 8008:8008 abdealijaroli/jaro:latest -s https://example.com +``` + +## 3. Transfer a file +``` +docker run -d --name jaro -e DB_URL=postgresql://user:password@host:port/dbname -p 8008:8008 abdealijaroli/jaro:latest -t /path/to/your/file ``` ## Features @@ -29,4 +39,4 @@ docker run -e DB_URL=postgresql://user:password@host:port/dbname -p 8008:8008 ab If you would like to contribute to Jaro, feel free to submit a pull request or open an issue. ## License -This project is open-source and available under the [MIT License](LICENSE). \ No newline at end of file +This project is open-source and available under the [MIT License](LICENSE).