Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rudyaffandi committed Oct 26, 2017
1 parent e1c077e commit 7cca184
Showing 1 changed file with 36 additions and 1 deletion.
37 changes: 36 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,42 @@
# ServerPilot PHP API Wrapper for Laravel 5
Version: 1.0.0

This is a Laravel 5.x wrapper for Dave Rogers' excellent [ServerPilot PHP API](https://github.com/daverogers/serverpilot-php). It comes with Service Container binding and Facade alias.

## Installation
1. Run `composer require lesaff/laravel-serverpilot`
2. Grab ServerPilot's API ID and Key from your SP's admin panel
3. Set `SERVERPILOT_API_ID` and `SERVERPILOT_API_KEY` in your `.env` file
4. Edit `app/config/app.php`,
add the following to your providers' array
```
Lesaff\LaravelServerPilot\ServerPilotServiceProvider::class,
```
add the following to your class aliases array
```
'SP' => Lesaff\LaravelServerPilot\Facades\ServerPilot::class,
```

## Usage

As a **Facade**
```
$servers = \SP::server_list();
```

As a **Dependency injection**
```
Route::get('/servers', function (\Lesaff\LaravelServerPilot $sp) {
$servers = $sp->server_list();
});
```

For full PHP API usage, please refer to https://github.com/daverogers/serverpilot-php

by Rudy Affandi (2017)
https://githubb.com/lesaff/laravel-serverpilot

Version: 1.0.0



** Work in Progress **

0 comments on commit 7cca184

Please sign in to comment.