README.md | 9 +++++---- diff --git a/README.md b/README.md index fddb3542a51370e14358cf4c90dd1064de316a15..d755996e3a063a00b79bd90d525e147c246cc245 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,8 @@ [![Build Status](https://travis-ci.org/Tarrasch/zsh-autoenv.svg?branch=master)](https://travis-ci.org/Tarrasch/zsh-autoenv) # Autoenv for Zsh -zsh-autoenv automatically sources `.env` files, typically used in project -root directories. +zsh-autoenv automatically sources (known/whitelisted) `.env` files, typically +used in project root directories. It handles "enter" and leave" events, nesting, and stashing of variables (overwriting and restoring). @@ -14,8 +14,9 @@ ## Features - Support for enter and leave events, which can use the same file. By default `.env` is used for entering, and `.env_leave` for leaving. - - Asks for confirmation / authentication before sourcing a `.env` file, and - remembers whitelisted files by its hash. + - Interactively asks for confirmation / authentication before sourcing an + unknown `.env` file, and remembers whitelisted files by their hashed + content. - Test suite. - Written in Zsh.