src/_README.md in planter-cli-0.0.4 vs src/_README.md in planter-cli-3.0.1
- old
+ new
@@ -19,10 +19,21 @@
## Configuration
Planter's base configuration is in `~/.config/planter/planter.yml`. This file can contain any of the keys used in templates (see below) and will serve as a base configuration for all templates. Any key defined in this file will be overridden if it exists in a template.
+Example config (written on first run):
+
+```yaml
+files:
+ .DS_Store: ignore
+ "*.tmp": ignore
+ "*.bak": ignore
+git_init: false
+preserve_tags: true
+```
+
### Scripts.
Scripts for execution after planting can be stored in `~/.config/planter/scripts` and referenced by filename only. Alternatively, scripts may be stored within a template in a `_scritps` subfolder.
Scripts can be executable files in any language, and receive the template directory and the planted directory as arguments $1 and $2.
@@ -97,9 +108,13 @@
"Planter": "%%title:cap%%"
"(main|app)\.js": "%%script:lower%%.js"
```
Replacements are performed on both file/directory names and file contents.
+
+### Finder Tags
+
+If `preserve_tags` is set to `true` in the config (either base or template), then existing Finder tags on the file or folder will be copied to the new file when a template is planted.
## Usage
The executable for Planter is `plant`. You can run `plant TEMPLATE` in any directory and TEMPLATE will be planted in the current directory. You can also use `--in PATH` to plant in another directory.