Skip to content

Commit c073f4e

Browse files
committed
fix: added correct docs
1 parent d482174 commit c073f4e

3 files changed

Lines changed: 26 additions & 1 deletion

File tree

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
[![Build](https://github.com/YarikRevich/ResourceTracker/actions/workflows/build.yml/badge.svg)](https://github.com/YarikRevich/ResourceTracker/actions/workflows/build.yml)
44
![AWS](https://img.shields.io/badge/AWS-%23FF9900.svg?style=for-the-badge&logo=amazon-aws&logoColor=white)
55
![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black)
6+
![MacOS](https://img.shields.io/badge/MacOS-8773f5?style=for-the-badge&logo=macos&logoColor=black)
67
[![StandWithUkraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md)
78

89
## General Information
@@ -55,8 +56,32 @@ After the execution of command given above the executable will be generated and
5556

5657
## Use cases
5758

59+
For both **CLI** and **GUI** examples, there was used the following user configuration file:
60+
```yaml
61+
requests:
62+
- name: "first"
63+
frequency: "10 * * * * *"
64+
file: "/Volumes/Files/first.sh"
65+
cloud:
66+
provider: "aws"
67+
credentials:
68+
file: "/Volumes/Files/aws.csv"
69+
region: "us-west-2"
70+
api-server:
71+
host: "http://localhost:8080"
72+
```
73+
74+
And the following request script file:
75+
```shell
76+
#!/bin/bash
77+
78+
echo "Hello world!"
79+
```
80+
5881
### CLI
5982

83+
![cli](./docs/example/cli.gif)
6084

85+
### GUI
6186

62-
### GUI
87+
![gui](./docs/example/gui.gif)

docs/example/cli.gif

4.8 MB
Loading

docs/example/gui.gif

4.09 MB
Loading

0 commit comments

Comments
 (0)