Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Florian Rusch (cluetec GmbH) authored Nov 9, 2023
1 parent 664bd70 commit a33bcbd
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,29 +21,31 @@ Destination storage systems:

## 🔥 Motivation

## 💻 Installation

## ⚙️ Usage

Lifeboat is designed as a CLI tool. That allows the user to use it in a large varient of environments like on a local machine, in a unix cronjob, in kubernetes, in a VM, where ever the user wants.
As the tool needs a quite complex configuration it's possible to provide a config file. In addition it's also possible to put all configuration also in environment variables.
Lifeboat is designed as a CLI tool. That allows the user to use it in a large varient of environments like on a local machine, in a unix cronjob, in kubernetes, in a VM, whereever the user wants.
As the tool needs a quite complex configuration it's possible to provide a config file. In addition, it's also possible to provide all configuration via environment variables.

TODO: put here cli help output

### Configurations
### Configuration

The configurations is divided in three different parts:
1. General configs

Check failure on line 36 in README.md

View workflow job for this annotation

GitHub Actions / lint

Lists should be surrounded by blank lines

README.md:36 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "1. General configs"] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md032.md
2. Source system configs
3. Destination storage configs

#### General configs
#### General configuration

TODO PUT HERE TABLE WITH THE CONFIGS

#### Source system configs
#### Source system configuration

TODO PUT HERE SUBSECTIONS WITH TABLES OF THE CONFIGS

#### Destination storage configs
#### Destination storage configuration

TODO PUT HERE SUBSECTIONS WITH TABLES OF THE CONFIGS

Expand Down

0 comments on commit a33bcbd

Please sign in to comment.