X-Git-Url: https://src.twobees.de/?a=blobdiff_plain;f=stow%2Foh-my-zsh%2F.oh-my-zsh%2Fplugins%2Fdotenv%2FREADME.md;fp=stow%2Foh-my-zsh%2F.oh-my-zsh%2Fplugins%2Fdotenv%2FREADME.md;h=0000000000000000000000000000000000000000;hb=1a8e170bbe5c6641a26ab1ce2e6ce6c5c1faa4cd;hp=ab9d329f6f8dc11ac0bd0ebf8d6d1c7602625a1f;hpb=475ba35502579302593f4735c853c49ef1845dcb;p=dotfiles.git

diff --git a/stow/oh-my-zsh/.oh-my-zsh/plugins/dotenv/README.md b/stow/oh-my-zsh/.oh-my-zsh/plugins/dotenv/README.md
deleted file mode 100644
index ab9d329..0000000
--- a/stow/oh-my-zsh/.oh-my-zsh/plugins/dotenv/README.md
+++ /dev/null
@@ -1,92 +0,0 @@
-# dotenv
-
-Automatically load your project ENV variables from `.env` file when you `cd` into project root directory.
-
-Storing configuration in the environment is one of the tenets of a [twelve-factor app](https://www.12factor.net). Anything that is likely to change between deployment environments, such as resource handles for databases or credentials for external services, should be extracted from the code into environment variables.
-
-To use it, add `dotenv` to the plugins array in your zshrc file:
-
-```sh
-plugins=(... dotenv)
-```
-
-## Usage
-
-Create `.env` file inside your project root directory and put your ENV variables there.
-
-For example:
-
-```sh
-export AWS_S3_TOKEN=d84a83539134f28f412c652b09f9f98eff96c9a
-export SECRET_KEY=7c6c72d959416d5aa368a409362ec6e2ac90d7f
-export MONGO_URI=mongodb://127.0.0.1:27017
-export PORT=3001
-```
-
-`export` is optional. This format works as well:
-
-```sh
-AWS_S3_TOKEN=d84a83539134f28f412c652b09f9f98eff96c9a
-SECRET_KEY=7c6c72d959416d5aa368a409362ec6e2ac90d7f
-MONGO_URI=mongodb://127.0.0.1:27017
-PORT=3001
-```
-
-You can even mix both formats, although it's probably a bad idea.
-
-## Settings
-
-### ZSH_DOTENV_FILE
-
-You can also modify the name of the file to be loaded with the variable `ZSH_DOTENV_FILE`.
-If the variable isn't set, the plugin will default to use `.env`.
-For example, this will make the plugin look for files named `.dotenv` and load them:
-
-```zsh
-# in ~/.zshrc, before Oh My Zsh is sourced:
-ZSH_DOTENV_FILE=.dotenv
-```
-
-### ZSH_DOTENV_PROMPT
-
-Set `ZSH_DOTENV_PROMPT=false` in your zshrc file if you don't want the confirmation message.
-You can also choose the `Always` option when prompted to always allow sourcing the .env file
-in that directory. See the next section for more details.
-
-### ZSH_DOTENV_ALLOWED_LIST, ZSH_DOTENV_DISALLOWED_LIST
-
-The default behavior of the plugin is to always ask whether to source a dotenv file. There's
-a **Y**es, **N**o, **A**lways and N**e**ver option. If you choose Always, the directory of the .env file
-will be added to an allowed list; if you choose Never, it will be added to a disallowed list.
-If a directory is found in either of those lists, the plugin won't ask for confirmation and will
-instead either source the .env file or proceed without action respectively.
-
-The allowed and disallowed lists are saved by default in `$ZSH_CACHE_DIR/dotenv-allowed.list` and
-`$ZSH_CACHE_DIR/dotenv-disallowed.list` respectively. If you want to change that location,
-change the `$ZSH_DOTENV_ALLOWED_LIST` and `$ZSH_DOTENV_DISALLOWED_LIST` variables, like so:
-
-```zsh
-# in ~/.zshrc, before Oh My Zsh is sourced:
-ZSH_DOTENV_ALLOWED_LIST=/path/to/dotenv/allowed/list
-ZSH_DOTENV_DISALLOWED_LIST=/path/to/dotenv/disallowed/list
-```
-
-The file is just a list of directories, separated by a newline character. If you want
-to change your decision, just edit the file and remove the line for the directory you want to
-change.
-
-NOTE: if a directory is found in both the allowed and disallowed lists, the disallowed list
-takes preference, _i.e._ the .env file will never be sourced.
-
-## Version Control
-
-**It's strongly recommended to add `.env` file to `.gitignore`**, because usually it contains sensitive information such as your credentials, secret keys, passwords etc. You don't want to commit this file, it's supposed to be local only.
-
-## Disclaimer
-
-This plugin only sources the `.env` file. Nothing less, nothing more. It doesn't do any checks. It's designed to be the fastest and simplest option. You're responsible for the `.env` file content. You can put some code (or weird symbols) there, but do it on your own risk. `dotenv` is the basic tool, yet it does the job.
-
-If you need more advanced and feature-rich ENV management, check out these awesome projects:
-
-* [direnv](https://github.com/direnv/direnv)
-* [zsh-autoenv](https://github.com/Tarrasch/zsh-autoenv)