diff --git a/README.MD b/README.MD index cff6354a..c6e9c21f 100644 --- a/README.MD +++ b/README.MD @@ -2,21 +2,44 @@ ## Introduction -Valet+ is a development environment for macOS. No Vagrant, no Docker, no `/etc/hosts` file. +Valet+ is a development environment for macOS. No Vagrant, no Docker, no `/etc/hosts` file. This project uses +[laravel/valet](https://github.com/laravel/valet) as a dependency. ## Installation -This project uses [laravel/valet](https://github.com/laravel/valet) as a dependency. You can follow the installation -instructions of Laravel's Valet. +> :warning: Valet+ requires macOS and [Homebrew](https://brew.sh/). Before installation, you should make sure that no +> other programs such as Apache or Nginx are binding to your local machine's port 80. + +> :warning: Valet+ requires [Composer](https://getcomposer.org/) to be installed. + +To get started, you first need to ensure that Homebrew is up to date using the update command: +```shell +brew update +``` + +Next, you should use Homebrew to install PHP 8.0: +```shell +brew install php@8.0 +brew link php@8.0 --force +brew services restart php@8.0 +``` + +Install Valet+ 3.x-dev with composer: +```shell +composer global require weprovide/valet-plus:3.x-dev +``` + +Finally, you may execute the Valet+ `install` command. This will configure and install Valet+, Nginx, DnsMasq and other +services. In addition, use `--help` to see all installation options. +```shell +valet-plus install +``` + +The daemons Valet+ depends on will be configured to launch when your system starts. Once Valet+ is installed, try pinging +any `*.test` domain on your terminal using a command such as `ping foobar.test`. If Valet+ is installed correctly you +should see this domain responding on `127.0.0.1`. -> Note: install php@8.0 first before installing Valet+. -> You can do this with the following commands. -> ```shell -> brew install php@8.0 -> brew link php@8.0 --force -> brew services restart php@8.0 -> ``` ## Valet+ features @@ -52,9 +75,9 @@ Here are a few key differences compared to the original Valet: ## Valet+ Authors +- Mischa Braam ([@mischabraam](https://github.com/mischabraam)) - Tim Neutkens ([@timneutkens](https://github.com/timneutkens)) - Sam Granger ([@samgranger](https://github.com/samgranger)) -- Mischa Braam ([@mischabraam](https://github.com/mischabraam)) ## Valet+ Contributors diff --git a/cli/valet.php b/cli/valet.php index c7916c6d..cb9201dc 100755 --- a/cli/valet.php +++ b/cli/valet.php @@ -68,7 +68,7 @@ info("\nValet+ installed successfully!"); }) - ->descriptions('Install the Valet services') + ->descriptions('Install the Valet+ services, with MySQL 5.7 as default DBMS.') ->addOption('with-mysql80', null, InputOption::VALUE_NONE, "Install with MySQL 8.0") ->addOption('with-mysql81', null, InputOption::VALUE_NONE, "Install with MySQL 8.1") ->addOption('with-mariadb', null, InputOption::VALUE_NONE, "Install with MariaDB") diff --git a/composer.json b/composer.json index d80e80b2..0da3f699 100644 --- a/composer.json +++ b/composer.json @@ -16,6 +16,9 @@ "WeProvide\\ValetPlus\\": "cli/ValetPlus/" } }, + "config": { + "platform-check": false + }, "require": { "php": ">=7.1 <8.3", "laravel/valet": "^4.1"