From eaa682c0a64daad3138e6f08e7b6c8825700049f Mon Sep 17 00:00:00 2001
From: Lukasz Chrzaszcz <lukasz.chrzaszcz@allegro.pl>
Date: Thu, 24 Oct 2019 17:42:33 +0200
Subject: [PATCH] Add profiles documentation

---
 plugins/profiles/README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 plugins/profiles/README.md

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)
+```