psi-jack/dotbot
1
0
Fork 0
mirror of synced 2024-11-22 08:15:34 -05:00
Code Issues Releases Wiki Activity

Update README

Browse source 
Add note on array syntax for shell commands being deprecated.
This commit is contained in:
Anish Athalye 2015-02-03 18:09:25 -05:00
parent 38c0f65801
commit f7a291c780
1 changed files with 7 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -160,13 +160,16 @@ base directory (that is specified when running the installer).
#### Format #### Format
Shell commands can be specified in several different ways. The simplest way is Shell commands can be specified in several different ways. The simplest way is
just to specify a command as a string containing the command to be run. Another just to specify a command as a string containing the command to be run. Shell
way is to specify a two element array where the first element is the shell
command and the second is an optional human-readable description. Shell
commands support an extended syntax as well, which provides more fine-grained commands support an extended syntax as well, which provides more fine-grained
control. A command can be specified as a dictionary that contains the command control. A command can be specified as a dictionary that contains the command
to be run, a description, and whether stdin, stdout, and stderr are enabled. In to be run, a description, and whether stdin, stdout, and stderr are enabled. In
this syntax, all keys are optional except for the command itself. this syntax, all keys are optional except for the command itself, and all
streams are disabled by default.
Another way is to specify a two element array where the first element is the
shell command and the second is an optional human-readable description. **This
syntax is deprecated.**
##### Example (YAML) ##### Example (YAML)