From 3083dc5f18c7c6c574ef7df850a655feaa35e7da Mon Sep 17 00:00:00 2001 From: Antonio De Lucreziis Date: Fri, 8 Mar 2024 02:14:07 +0100 Subject: [PATCH] chore: updated readme --- README.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 0fda2d5..c77835d 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,11 @@ Continuous Deployment for PHC projects. # First install the dependencies $ pnpm install -# Run the app -$ pnpm run dev +# Run the local server +$ pnpm dev + +# Build all +$ pnpm build ``` ## Architecture @@ -20,7 +23,9 @@ Everything is stored in the `config.yaml` file. This file contains a list of pro deploys: - name: project1 url: https://github.com/username/project1 - branch: main + ref: + type: branch + value: main type: dockerfile options: ports: @@ -29,7 +34,9 @@ deploys: - /var/www/html:/var/www/html - name: project2 url: ssh://example.org/username/project2.git - commit: 04c540647a + ref: + type: commit + value: '1234567' type: docker-compose options: path: ./docker-compose.yml # already the default @@ -38,4 +45,5 @@ deploys: type: shell options: path: ./deploy.sh # already the default -``` \ No newline at end of file +``` +