diff --git a/README.md b/README.md new file mode 100644 index 0000000..edbec7d --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +## Docker Decompose + +This utility is designed for building and exporting containers running via Docker Compose. +As a result, the utility generates images as `.tar` files. +These files can later be imported into Mikrotik CHR. + +## Installation + +- Install the `git` and `php` packages to run the script +- Navigate to the directory where you want to download the utility + +```shell +cd /opt +``` + +- Download the code from Git + +```shell +git clone https://git.kirillius.ru/kirillius/docker-decompose.git +``` + +- Navigate to the directory + +```shell +cd docker-decompose +``` + +- Allow the utility to be executed + +```shell +chmod +x docker-decompose.php +``` + +- Create a symbolic link in PATH to run the utility + +```shell +ln -s /opt/docker-decompose/docker-decompose.php /usr/bin/docker-decompose +``` + +## Usage Example + +```shell +cd folder_contains_docker-compose.yml_file +docker-decompose +``` \ No newline at end of file