From 19aea9a2c35a8948473b0b2fe3fdce0299812588 Mon Sep 17 00:00:00 2001 From: Matt Stauffer Date: Thu, 5 May 2016 08:37:06 -0400 Subject: [PATCH] Link dnsmasq and clarify some wording --- readme.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/readme.md b/readme.md index d046a6b8d..828981e22 100644 --- a/readme.md +++ b/readme.md @@ -14,7 +14,7 @@ Valet is a Laravel development environment for Mac minimalists. No Vagrant, No Apache, No Nginx, No `/etc/hosts` file. You can even share your sites publicly using local tunnels. _Yeah, we like it too._ -Laravel Valet configures your Mac to always run PHP's built-in web server in the background when your machine starts. Then, using DnsMasq, Valet proxies all requests on the `*.dev` domain to point to sites installed on your local machine. +Laravel Valet configures your Mac to always run PHP's built-in web server in the background when your machine starts. Then, using [DnsMasq](https://en.wikipedia.org/wiki/Dnsmasq), Valet proxies all requests on the `*.dev` domain to point to sites installed on your local machine. In other words, a blazing fast Laravel development environment that uses roughly 7mb of RAM. Valet isn't a complete replacement for Vagrant or Homestead, but provides a great alternative if you just need the basics, prefer extreme speed, or are working on a machine with a limited amount of RAM. @@ -29,7 +29,7 @@ Valet supports [Laravel](https://laravel.com), [Lumen](https://lumen.laravel.com 2. Make sure `brew services` is available by running `brew services list` and making sure you get valid output. If it is not available, [add it](https://github.com/Homebrew/homebrew-services). 3. Install PHP 7.0 via Homebrew via `brew install php70`. 4. Install Valet with Composer via `composer global require laravel/valet`. Make sure the `~/.composer/bin` directory is in your system's "PATH". -5. Run the `valet install` command. This will configure and install Valet, DnsMasq, and register Valet's daemon to launch when your system starts. +5. Run the `valet install` command. This will configure and install Valet and DnsMasq, and register Valet's daemon to launch when your system starts. Once Valet is installed, try pinging any `*.dev` domain on your terminal using a command such as `ping foobar.dev`. If Valet is installed correctly you should see this domain responding on `127.0.0.1`. @@ -47,7 +47,7 @@ Once Valet is installed, you're ready to start serving sites. Valet provides two **The `park` Command** -- Create a new directory on your Mac such `mkdir ~/Sites`. Next, `cd ~/Sites` and run `valet park`. This command will register your current working directory as a path that Valet should search for sites. +- Create a new directory on your Mac by running something like `mkdir ~/Sites`. Next, `cd ~/Sites` and run `valet park`. This command will register your current working directory as a path that Valet should search for sites. - Next, create a new Laravel site within this directory: `laravel new blog`. - Now you may simply open `http://blog.dev` in your browser. @@ -58,7 +58,7 @@ Once Valet is installed, you're ready to start serving sites. Valet provides two The `link` command may also be used to serve your Laravel sites. This command is useful if you just want to serve a single site in a directory and not the entire directory. -- To use the command, navigate to one of your Laravel applications and run `valet link app-name` in your terminal. Valet will create a symbolic link in `~/.valet/Sites` which points to your current working directory. +- To use the command, navigate to one of your projects and run `valet link app-name` in your terminal. Valet will create a symbolic link in `~/.valet/Sites` which points to your current working directory. - After running the `link` command, you may simply access the site in your browser at `http://app-name.dev`. To see a listing of all of your linked directories, run the `valet links` command. You may use `valet unlink app-name` to destroy the symbolic link. @@ -68,7 +68,7 @@ To see a listing of all of your linked directories, run the `valet links` comman Valet even includes a command to share your local sites with the world. No additional software installation is required once Valet is installed. -To share a site, simply navigate to the site and run the `valet share` command. A publicly accessible URL will be inserted into your clipboard and is ready to paste directly into your browser. It's just that simple. +To share a site, simply navigate to the site's directory and run the `valet share` command. A publicly accessible URL will be inserted into your clipboard and is ready to paste directly into your browser. It's just that simple. To stop sharing your site, simply hit `Control + C` to cancel the process.