fixies and added Makefile.sample.md

Author: krom

.gitignore

@@ -0,0 +1,2 @@
+.idea
+.vscode

CHANGELOG.md

@@ -0,0 +1,14 @@
+## 1.0.1 (2018-06-06)
+* Added Makefile.sample.mk
+* Added CHANGELOG.md
+
+## 1.0.0 (2018-06-05)
+* Added simple installation script
+* Added **mk-version** and **mk-upgrade** commands
+* Added to self upgrade script with **mk-upgrade** command
+* Changed library from *.makefile-lib* to *mk-lib*
+* Added support of absolute paths
+* Added [website](https://kudlay.pro/docker-compose-makefile/)
+
+## v0.9 (2017-11-21)
+* Initial version with basic functionality

README.md

@@ -39,7 +39,7 @@ USAGE
 SAMPLES
 -------
 
-You may see sampess [here](https://github.com/krom/docker-compose-makefile/tree/master/samples)
+You may see samples [here](https://github.com/krom/docker-compose-makefile/tree/master/samples)
 
 CUSTOMIZATION
 -------------

scripts/build.sh

@@ -1,10 +1,20 @@
 #!/usr/bin/env sh
 echo "Building release"
-out=release/.mk-lib/
-mkdir -p $out
-cp -r src/* $out
-cp README.md $out
-cp LICENSE $out
-echo "MK_VERSION := $TRAVIS_TAG" > $out/version.mk
+OUT=release/.mk-lib
+
+# Creating dir
+mkdir -p $OUT
+
+# Coping files
+cp -r src/* $OUT
+cp README.md $OUT
+cp LICENSE $OUT
+cp CHANGELOG.md $OUT
+cp samples/Makefile $OUT/Makefile.sample.mk
+
+# Writing current version
+echo "MK_VERSION := $TRAVIS_TAG" > $OUT/version.mk
+
+# Compressing release to *.zip and *.tgz
 tar -czf release.tgz -C release .
 cd release/; zip -r ../release.zip .; cd ..

scripts/install.sh

@@ -1,19 +1,35 @@
-#/bin/sh
+#!/bin/sh
+
+# Docker compose installation script
+# Execute this script with command
+#   curl -sL https://git.io/vh4Gn | sh
+
+# Main repo address
 REPO=krom/docker-compose-makefile
+
 get_latest_release() {
   curl --silent "https://api.github.com/repos/$1/releases/latest" | # Get latest release from GitHub api
     grep '"tag_name":' |                                            # Get tag line
     sed -E 's/.*"([^"]+)".*/\1/'                                    # Pluck JSON value
 }
 
-v=$(get_latest_release $REPO)
-release=https://github.com/$REPO/releases/download/$v/release.tgz
-echo Downloading version $v from $release
-curl -Ls $release | tar zxfm -
+# Getting URL to release archive
+V=$(get_latest_release $REPO)
+RELEASE=https://github.com/$REPO/releases/download/$V/release.tgz
+
+# Downloading and extracting release
+echo Downloading version $V from $RELEASE
+curl -Ls $RELEASE | tar zxfm -
 echo 'Created .mk-lib'
+
+# Creating Makefile if needed
 if [ -f Makefile ]; then
-    echo "Makefile exists. Please add this section to the head of Makefile"
-    cat .mk-lib/HEADER.mk 
+    echo "Makefile exists. Please add this section to the head of Makefile
+
+-------------------------------------------------------------------------------"
+    cat .mk-lib/HEADER.mk
+    echo "-------------------------------------------------------------------------------
+"
 else
     cp .mk-lib/HEADER.mk Makefile
     echo "Created new Makefile. Feel free to add new commands"

scripts/upgrade.sh

@@ -1,4 +1,10 @@
+# Docker compose upgrading script
+# Execute this script with command
+#   make mk-upgrade
+
 RELEASE=https://github.com/$MK_REPO/releases/download/$MK_VERSION/release.tgz
+
+# Downloading new release
 echo "Downloading version $MK_VERSION from $RELEASE"
 curl -Ls $RELEASE | tar zxfm -
 echo "Done"