diff --git a/.markdownlint.yaml b/.markdownlint.yaml index 0e98dd1..3bc2098 100644 --- a/.markdownlint.yaml +++ b/.markdownlint.yaml @@ -45,11 +45,11 @@ MD012: # MD013/line-length - Line length MD013: # Number of characters - line_length: 80 + line_length: 120 # Number of characters for headings - heading_line_length: 80 + heading_line_length: 120 # Number of characters for code blocks - code_block_line_length: 80 + code_block_line_length: 120 # Include code blocks code_blocks: false # Include tables diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..b18cb90 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,3 @@ +{ + "rewrap.wrappingColumn": 120, +} \ No newline at end of file diff --git a/README.md b/README.md index 8cea04c..8b60b88 100644 --- a/README.md +++ b/README.md @@ -3,22 +3,18 @@ [![Build Status](https://drone.cryptic.systems/api/badges/volker.raschek/dcmerge/status.svg)](https://drone.cryptic.systems/volker.raschek/dcmerge) [![Docker Pulls](https://img.shields.io/docker/pulls/volkerraschek/dcmerge)](https://hub.docker.com/r/volkerraschek/dcmerge) -`dcmerge` is a small program to merge docker-compose files from multiple -sources. It is available via RPM and docker. +`dcmerge` is a small program to merge docker-compose files from multiple sources. It is available via RPM and docker. -The dynamic pattern of a docker-compose file, that for example `environments` -can be specified as a string slice or a list of objects is currently not -supported. `dcmerge` expect a strict pattern layout. The `environments`, `ports` -and `volumes` must be declared as a slice of strings. +The dynamic pattern of a docker-compose file, that for example `environments` can be specified as a string slice or a +list of objects is currently not supported. `dcmerge` expect a strict pattern layout. The `environments`, `ports` and +`volumes` must be declared as a slice of strings. -Dockercompose file can be read-in from different sources. Currently are the -following sources supported: +Dockercompose file can be read-in from different sources. Currently are the following sources supported: - File - HTTP/HTTPS -Furthermore, `dcmerge` support different ways to merge multiple docker-compose -files. +Furthermore, `dcmerge` support different ways to merge multiple docker-compose files. - The default merge, add missing secrets, services, networks and volumes. - The existing-win merge, add and protect existing attributes. @@ -26,9 +22,8 @@ files. ## default -Merge only missing secrets, services, networks and volumes without respecting -their attributes. For example, when the service `app` is already declared, it is -not possible to add the service `app` twice. The second service will be +Merge only missing secrets, services, networks and volumes **without respecting their attributes**. For example, when +the service `app` is already declared, it is not possible to add the service `app` twice. The second service will be completely skipped. ```yaml @@ -68,10 +63,9 @@ services: ## existing-win -The existing-win merge protects existing attributes. For example there are two -different docker-compose files, but booth has the same environment variable -`CLIENT_SECRET` defined with different values. The first declaration of the -attribute wins and is for overwriting protected. +The existing-win merge protects existing attributes. For example there are two different docker-compose files, but booth +has the same environment variable `CLIENT_SECRET` defined with different values. The first declaration of the attribute +wins and is for overwriting protected. ```yaml --- @@ -99,9 +93,8 @@ services: ## last-win -The last-win merge overwrite recursive existing attributes. For example there -are two different docker-compose files, but booth has the same environment -variable `CLIENT_SECRET` defined with different values. The last passed +The last-win merge overwrite recursive existing attributes. For example there are two different docker-compose files, +but booth has the same environment variable `CLIENT_SECRET` defined with different values. The last passed docker-compose file which contains this environment wins. ```yaml