summaryrefslogtreecommitdiff
path: root/plugins/profiles/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/profiles/README.md')
-rw-r--r--plugins/profiles/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/plugins/profiles/README.md b/plugins/profiles/README.md
new file mode 100644
index 000000000..b590a370f
--- /dev/null
+++ b/plugins/profiles/README.md
@@ -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)
+```