README.md in doit-1.0.2 vs README.md in doit-1.0.3
- old
+ new
@@ -1,48 +1,49 @@
-Doit
-====
+# Doit
+[](http://badge.fury.io/rb/doit)
+
Executes good old shell/bash scripts locally as well as remotely.
The environment is set by a ".yml" configuration file.
An array environment variable triggers multiple calls of the script.
The "where" in the configuration indicates where to run the script.
See examples below.
-Installation
-------------
+## Installation
+
gem install doit
-Usage
------
+## Usage
+
doit script... [options]
doit push
doit deploy tag
-Options
--------
+## Options
+
-l, --[no-]list Lists available scripts
-r, --remote ["host"] remote host or comma separated hosts
-e, --[no-]each Lists each remote command (no execution)
-s, --[no-]silent run silently; suppress output
-v, --[no-]verbose Enable verbose output
-n, --[no-]noop Suppress execution of commannds
-h, --help Show this message
-V, --version Print version
-File Structure
---------------
+## File Structure
+
~/.doit/deploy # chmod +x .doit/deploy
~/.doit/deploy.yml
$PROJ/.doit/deploy.yml # overwrites $HOME(~/) script/configuration
$PROJ/.doit/push # chmod +x .doit/push
$PROJ/.doit/push.yml
-$PROJ/.doit/push
-----------------
+## $PROJ/.doit/push
+
#! /bin/sh
if ! (git status | grep 'nothing to commit'); then
echo "push: commits are pending"
exit 1
fi
@@ -59,20 +60,25 @@
master)
git push origin master
;;
esac
-~/.doit/deploy
---------------
+## ~/.doit/deploy
+
uname -a
git status
-~/.doit/deploy.yml
-------------------
+## ~/.doit/deploy.yml
+
env:
- DIR=tmp OPTION=run
- DIR=proj OPTION=list
where:
- bob@sample.com
- alice@customer.com
-Copyright (c) 2014-2019 [Dittmar Krall], released under the MIT license.
+## Miscellaneous
+
+Copyright (c) 2014-2023 Dittmar Krall (www.matiq.com),
+released under the MIT license:
+
+* https://opensource.org/licenses/MIT