Skip to content

Commit

Permalink
📚 Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lorisleiva authored Mar 9, 2018
1 parent 6569c49 commit 0dd85fe
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ Laravel Deployer is a lightweight wrapper of [Deployer](https://github.com/deplo
* [Documentation](docs)
* Blog article (TODO)

## Installation
![Console output example](https://user-images.githubusercontent.com/3642397/37216796-04ac518e-23bc-11e8-8f6b-58ef22e4d747.png)

## 1️⃣ Installation

```bash
composer require lorisleiva/laravel-deployer
Expand All @@ -16,7 +18,7 @@ As you know, from Laravel 5.5 it will automatically discover the package. Before
Lorisleiva\LaravelDeployer\LaravelDeployerServiceProvider::class
```

## Configuration
## 2️⃣ Configuration
In order to generate your deployment configuration file, simply run:

```bash
Expand All @@ -27,7 +29,7 @@ It will ask you a few questions to help you get started and generate a `deploy.p

Read more about the available options, tasks, recipes; about how to customize your hosts, your deployment flow; about the gotchas of deploying an app that is already live and much more in the [documentation](docs).

## Deployment
## 3️⃣ Deployment
When you’re ready to deploy, run:

```bash
Expand All @@ -40,7 +42,7 @@ Because we are using zero-downtime deployments, make sure your server’s root p

If your project has already been deployed, before using Laravel Deployer, be sure to [read this](docs/first-deploy.md).

## Available commands
## 📜 Available commands

```bash
deploy # Deploy your Laravel application
Expand All @@ -52,4 +54,4 @@ deploy:init # Generate deploy.php configuration file
deploy:list # Lists available tasks
deploy:run <task> # Execute a given task on your hosts
ssh # Connect to host through ssh
```
```

0 comments on commit 0dd85fe

Please sign in to comment.