Edit docs

adnanjaw · Oct 29, 2024 · b581fb2 · b581fb2
1 parent 2545c8c
commit b581fb2
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 11 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -1,13 +1,10 @@
 # cronned-rclone 
-[![Test image](https://github.com/adnanjaw/cronned-rclone/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/adnanjaw/cronned-rclone/actions/workflows/test.yml) |
-[![Release image](https://github.com/adnanjaw/cronned-rclone/actions/workflows/release.yml/badge.svg)](https://github.com/adnanjaw/cronned-rclone/actions/workflows/release.yml)
+[![Test image](https://github.com/adnanjaw/cronned-rclone/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/adnanjaw/cronned-rclone/actions/workflows/test.yml) [![Release image](https://github.com/adnanjaw/cronned-rclone/actions/workflows/release.yml/badge.svg)](https://github.com/adnanjaw/cronned-rclone/actions/workflows/release.yml)
 
 A lightweight container tool that wraps Rclone with cron jobs using Ofelia. Easily schedule Rclone commands with
 flexible cron expressions via INI-style configurations or Docker labels, while utilizing all standard Rclone commands.
 
----
-
-## Features
+### Features
 
 - **Rclone Integration**: Leverage the powerful [Rclone](https://rclone.org/) for cloud operations (sync, copy, move,
   etc.).

diff --git a/docs/usage.md b/docs/usage.md
@@ -5,9 +5,9 @@
 Define your cron jobs using a configuration file (e.g., `config.ini`). Refer to
 the [Ofelia documentation](https://github.com/mcuadros/ofelia) for more details on available parameters.
 
-### - Example `config.ini`
-
 ```ini
+#### config.ini ####
+
 ### Jobs Reference Documentation: https://github.com/mcuadros/ofelia/blob/master/docs/jobs.md ###
 [job-exec "job-executed-on-running-container"]
 schedule = @hourly
@@ -52,6 +52,10 @@ slack-only-on-error = true
 
 After preparing your configuration file, run the `cronned-rclone` Docker container.
 
+### Docker run command using config
+
+In case you are using Ofelia config.ini.
+
 ```bash
 docker run --name cronned-rclone \
   -v /var/run/docker.sock:/var/run/docker.sock:ro \
@@ -62,9 +66,9 @@ docker run --name cronned-rclone \
   adnanjaw/cronned-rclone:latest daemon --config=/config/ofelia.ini
 ```
 
-### - Labels
+### Docker run command using labels
 
-In case you are using Ofelia labels, you can add this command at the end of your Docker run or Docker Compose command.
+In case you are using Ofelia labels.
 
 ```bash
 docker run --name cronned-rclone \
@@ -79,7 +83,7 @@ docker run --name cronned-rclone \
   adnanjaw/cronned-rclone:latest daemon --docker
 ```
 
-### - Run with Docker Compose
+### Run with Docker Compose using config.ini
 
 To run the container using Docker Compose, create a `compose.yaml` file:
 
@@ -96,7 +100,7 @@ services:
       - ./rclone/config:/config/rclone
 ```
 
-### - Labels
+### Run with Docker Compose using labels
 
 ```yaml
 services: