diff --git a/README.md b/README.md index 59c63a8..cdb0322 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,8 @@ - - - @@ -109,6 +106,28 @@ Additionally, you can use Vail to run any command within the context of your app ./node_modules/.bin/vail exec app node --version ``` +### Configuring A Shell Alias + +Instead of repeatedly typing `./node_modules/.bin/vail` to execute Vail commands, you may wish to configure a shell alias that allows you to execute Vail's commands more easily: + +```sh +alias vail='[ -f vail ] && sh vail || sh node_modules/.bin/vail' +``` + +To make sure this is always available, you may add this to your shell configuration file in your home directory, such as ~/.zshrc or ~/.bashrc, and then restart your shell. + +Once the shell alias has been configured, you may execute Vail commands by simply typing vail. + +```sh +vail up +``` + +## Available Services + +Vail supports the following services: + +- MySQL + ## Support

You can show your support by starring this project.