diff --git a/README.md b/README.md index bc20e9d..c861e1a 100644 --- a/README.md +++ b/README.md @@ -119,7 +119,7 @@ the source path, specify "create" as true if the parent directory should be created if necessary, and specify "force" as true if the file or directory should be forcibly linked. -##### Example (YAML) +#### Example ```yaml - link: @@ -133,25 +133,6 @@ should be forcibly linked. path: zshrc ``` -##### Example (JSON) - -```json -[{ - "link": { - "~/.config/terminator": { - "create": true, - "path": "config/terminator/" - }, - "~/.vim": "vim/", - "~/.vimrc": "vimrc", - "~/.zshrc": { - "force": true, - "path": "zshrc" - } - } -}] -``` - ### Shell Shell commands specify shell commands to be run. Shell commands are run in the @@ -168,7 +149,7 @@ 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 this syntax, all keys are optional except for the command itself. -##### Example (YAML) +#### Example ```yaml - shell: @@ -183,26 +164,6 @@ this syntax, all keys are optional except for the command itself. stderr: true ``` -##### Example (JSON) - -```json -[{ - "shell": [ - "mkdir -p ~/src", - ["mkdir -p ~/downloads", "Creating downloads directory"], - { - "command": "read var && echo Your variable is $var", - "stdin": true, - "stdout": true - }, - { - "command": "read fail", - "stderr": true - } - ] -}] -``` - ### Clean Clean commands specify directories that should be checked for dead symbolic @@ -213,20 +174,12 @@ to the dotfiles directory are removed. Clean commands are specified as an array of directories to be cleaned. -##### Example (YAML) +#### Example ```yaml - clean: ['~'] ``` -##### Example (JSON) - -```json -[{ - "clean": ["~"] -}] -``` - ### Full Example The configuration file format is pretty simple. Here's an example of a complete