chore: updated readme

main
Antonio De Lucreziis 11 months ago
parent e87a9bef18
commit 3083dc5f18

@ -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
```
```

Loading…
Cancel
Save