Add profiles documentation

This commit is contained in:
Lukasz Chrzaszcz 2019-10-24 17:42:33 +02:00
parent 40df67bc3b
commit eaa682c0a6

View File

@ -0,0 +1,21 @@
# profiles plugin
This plugin allows you to create separate configuration files for zsh based
on a domain of your host.
It takes your `HOST` and looks for files named according to the domain parts
in `$ZSH_CUSTOM/profiles/` directory.
For example, for `HOST=my.domain.com`, it will try to load the following files:
```text
$ZSH_CUSTOM/profiles/my.domain.com
$ZSH_CUSTOM/profiles/domain.com
$ZSH_CUSTOM/profiles/com
```
To use it, add profiles to the plugins array of your zshrc file:
```sh
plugins=(... profiles)
```