Skip to content

Commit

Permalink
Update help
Browse files Browse the repository at this point in the history
  • Loading branch information
veerendra2 committed Dec 24, 2024
1 parent 8d8ce28 commit ce89044
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Kompozit

![Docker Pulls](https://img.shields.io/docker/pulls/veerendra2/kompozit) ![PyPI - Status](https://img.shields.io/pypi/status/kompozit) ![PyPI - Version](https://img.shields.io/pypi/v/kompozit) [![Release](https://github.com/veerendra2/kompozit/actions/workflows/release.yml/badge.svg)](https://github.com/veerendra2/kompozit/actions/workflows/release.yml)
> ℹ Mostly likely you may want to use [Use multiple Compose files](https://docs.docker.com/compose/how-tos/multiple-compose-files/) in Docker Compose itself.
[![Docker Pulls](https://img.shields.io/docker/pulls/veerendra2/kompozit)](https://hub.docker.com/r/veerendra2/kompozit) [![PyPI - Status](https://img.shields.io/pypi/status/kompozit)](https://pypi.org/project/kompozit/) [![PyPI - Version](https://img.shields.io/pypi/v/kompozit)](https://pypi.org/project/kompozit/) [![PyPI - Downloads](https://img.shields.io/pypi/dm/kompozit)](https://pypi.org/project/kompozit/) [![Release](https://github.com/veerendra2/kompozit/actions/workflows/release.yml/badge.svg)](https://github.com/veerendra2/kompozit/actions/workflows/release.yml)

> ℹ Mostly likely you may want to use [Use multiple Compose files](https://docs.docker.com/compose/how-tos/multiple-compose-files/) in Docker Compose itself.
Declarative Configuration Management Tool for Docker Compose.

Expand Down Expand Up @@ -43,15 +43,15 @@ Additionally, kompozit allows you to combine multiple `docker-compose.yml` files
```bash
python -m pip install kompozit

kompozit --help
kompozit -h
usage: kompozit [-h] [-b BUILD_PATH] [-o OUTPUT_DIR] [-v]

Declarative Configuration Management Tool for Docker Compose.

options:
-h, --help show this help message and exit
-b, --build BUILD_PATH
Path to a directory containing 'komposition.yaml'. (default: .)
Path to a directory containing 'kompozition.yaml' or 'kompozition.yml'. (default: .)
-o, --output-dir OUTPUT_DIR
Directory to save the generated Docker Compose files. (default: None)
-v, --version Show kompozit version
Expand All @@ -65,7 +65,7 @@ options:
docker pull veerendra2/kompozit
```

## Usage ⚙️
## Usage Examples ⚙️

```bash
git clone [email protected]:veerendra2/kompozit.git
Expand Down
4 changes: 2 additions & 2 deletions kompozit/kompozit.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
from jsonpatch import JsonPatchConflict
from jsonpointer import JsonPointerException

__version__ = "0.2.0-beta"
__version__ = "0.2.1-beta"


CONFIG_FILE_NAMES = ["kompozition.yaml", "kompozition.yml"]
Expand All @@ -37,7 +37,7 @@ def parse_arguments():
dest="build_path",
type=str,
required=False,
help="Path to a directory containing 'komposition.yaml'.",
help="Path to a directory containing 'kompozition.yaml' or 'kompozition.yml'.",
)
parser.add_argument(
"-o",
Expand Down

0 comments on commit ce89044

Please sign in to comment.