eaa682c0a64daad3138e6f08e7b6c8825700049f

Author
Lukasz Chrzaszcz <lukasz.chrzaszcz@allegro.pl>
Committer
Lukasz Chrzaszcz <lukasz.chrzaszcz@allegro.pl>
Date

Message

Add profiles documentation

Diff

 1diff --git a/plugins/profiles/README.md b/plugins/profiles/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..b590a370f49b2f2f9d17097c83b4a293b8452bca
 4--- /dev/null
 5+++ b/plugins/profiles/README.md
 6@@ -0,0 +1,21 @@
 7+# profiles plugin
 8+
 9+This plugin allows you to create separate configuration files for zsh based
10+on a domain of your host.
11+
12+It takes your `HOST` and looks for files named according to the domain parts 
13+in `$ZSH_CUSTOM/profiles/` directory.
14+
15+For example, for `HOST=my.domain.com`, it will try to load the following files:
16+
17+```text
18+$ZSH_CUSTOM/profiles/my.domain.com
19+$ZSH_CUSTOM/profiles/domain.com
20+$ZSH_CUSTOM/profiles/com
21+```
22+
23+To use it, add profiles to the plugins array of your zshrc file:
24+
25+```sh
26+plugins=(... profiles)
27+```