From 8e0f9853f4b49cd890edc3abfbb7965be8d71386 Mon Sep 17 00:00:00 2001 From: Ariful Alam Date: Sun, 6 Aug 2023 13:52:58 +0600 Subject: [PATCH 1/2] Add usage guide of configuring shell alias --- README.md | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 59c63a8..13a1d46 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,8 @@ - - - @@ -109,6 +106,22 @@ 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 +``` + ## Support

You can show your support by starring this project.

From d6ee07aa8cfbccfe0e5853ddbcc6fbfe672e2a4e Mon Sep 17 00:00:00 2001 From: Ariful Alam Date: Sun, 6 Aug 2023 14:01:49 +0600 Subject: [PATCH 2/2] Include service section --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 13a1d46..cdb0322 100644 --- a/README.md +++ b/README.md @@ -122,6 +122,12 @@ Once the shell alias has been configured, you may execute Vail commands by simpl vail up ``` +## Available Services + +Vail supports the following services: + +- MySQL + ## Support

You can show your support by starring this project.