Skip to content

Commit

Permalink
docs: update config description in readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SlaviXG authored Jun 22, 2024
1 parent 53fab83 commit 5e9f151
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,13 +95,14 @@ This guide explains how to set up the configuration file (`config.ini`) and what
### [operator] Section

- **registration_timeout**: The time (in seconds) to wait for clients to register. Default is `5`.
- **enable_pipeline_mode**: Boolean option to enable or disable pipeline mode. If `True`, the defined pipelines will be executed in order. Default is `True`.
- **enable_pipeline_mode**: Boolean option to enable or disable pipeline mode. If `True`, the defined pipelines will be executed in order. Default is `False`.
- **enable_realtime_mode**: Boolean option to enable or disable real-time mode. If `True`, commands can be sent to clients in real-time via the terminal. Default is `True`.
- **jsonify**: Boolean option to enable or disable JSON formatting of messages. If `True`, messages will be formatted as JSON. Default is `True`.
- **colorlog**: Boolean option to enable or disable color logging in the terminal. If `True`, logs will be colored for better readability. Default is `True`.
- **colorlog**: Boolean option to enable or disable color logging in the terminal. If `True`, logs will be colored for better readability. Default is `False`.
- **save_feedback**: Boolean option to enable or disable saving feedback to a file. If `True`, feedback from clients will be saved to the specified feedback file. Default is `True`.
- **feedback_file**: The name of the file where feedback will be saved. Default is `feedback.txt`.

- **receive_commands**: Boolean option to receive commands from the program that implements BaseCommander. Default is `True`.

### [commander] Section
**jsonify**: Boolean option to enable or disable JSON formatting of messages. If True, messages will be formatted as JSON. Default is True.

Expand Down

0 comments on commit 5e9f151

Please sign in to comment.