Skip to content

Commit 72685d4

Browse files
committed
Updated readme
1 parent 90ee6a2 commit 72685d4

File tree

1 file changed

+18
-26
lines changed

1 file changed

+18
-26
lines changed

README.md

Lines changed: 18 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
Docker compose makefile
2-
=======================
3-
1+
# Docker compose makefile
42
[![Build Status](https://travis-ci.org/krom/docker-compose-makefile.svg?branch=master)](https://travis-ci.org/krom/docker-compose-makefile)
53
[![Release](https://img.shields.io/github/release/krom/docker-compose-makefile.svg)](https://github.com/krom/docker-compose-makefile/releases/latest)
64
[![Commits since last release](https://img.shields.io/github/commits-since/krom/docker-compose-makefile/latest.svg)](https://github.com/krom/docker-compose-makefile/commits/master)
@@ -12,16 +10,20 @@ Docker compose makefile
1210

1311
Template and lib for docker-compose
1412

15-
INSTALLATION
16-
------------
17-
Execute
13+
## INSTALLATION
14+
### INSTALLATION
15+
To install mk-lib run command
1816
```bash
1917
curl -sL https://git.io/vh4Gn | sh
2018
```
2119

22-
USAGE
23-
-----
20+
### UPGRADE
21+
To upgrade existing mk-lib run command
22+
```bash
23+
make mk-upgrade
24+
```
2425

26+
## USAGE
2527
![Screen](https://raw.githubusercontent.com/krom/docker-compose-makefile/master/docs/screencast.gif)
2628

2729
**Common (see [samples](https://github.com/krom/docker-compose-makefile/tree/master/samples))**
@@ -36,14 +38,13 @@ USAGE
3638
- **make mk-upgrade** - check for updates of mk-lib
3739
- **make mk-version** - show current version of mk-lib
3840

39-
SAMPLES
40-
-------
41+
## SAMPLES
4142

4243
Basic commands (you can copy and paste it into your Makefile)
4344

4445
```makefile
4546
up: ## Start all or c=<name> containers in foreground
46-
@$(DOCKER_COMPOSE) -f $(DOCKER_COMPOSE_FILE) up -d $(c)
47+
@$(DOCKER_COMPOSE) -f $(DOCKER_COMPOSE_FILE) up $(c)
4748

4849
start: ## Start all or c=<name> containers in background
4950
@$(DOCKER_COMPOSE) -f $(DOCKER_COMPOSE_FILE) up -d $(c)
@@ -63,32 +64,23 @@ clean: ## Clean all data
6364
```
6465
You may see samples [here](https://github.com/krom/docker-compose-makefile/tree/master/samples)
6566

66-
CUSTOMIZATION
67-
-------------
67+
## CUSTOMIZATION
6868
You can create _.make.env_ file in directory with Makefile or **current** directory
6969

7070
Available variables
7171

7272
* DOCKER_COMPOSE = {docker-compose executable command}
7373
* DOCKER_COMPOSE_FILE = {custom docker-compose.yml file}
7474

75-
TO-DO
76-
-----
77-
75+
## TO-DO
7876
- check dependencies
7977
- update readme
8078

81-
CHANGELOG
82-
---------
83-
84-
See [CHANGELOG](CHANGELOG.md))
85-
86-
LICENSE
87-
-------
79+
## CHANGELOG
80+
See [CHANGELOG](CHANGELOG.md)
8881

82+
## LICENSE
8983
MIT (see [LICENSE](LICENSE))
9084

91-
AUTHOR
92-
------
93-
85+
## AUTHOR
9486
[Roman Kudlay](http://roman.kudlay.pro) ([roman@kudlay.pro](mailto:roman@kudlay.pro))

0 commit comments

Comments
 (0)