Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jdelaune committed Feb 28, 2015
1 parent 0626df0 commit f6d0c12
Showing 1 changed file with 20 additions and 8 deletions.
28 changes: 20 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,16 +58,28 @@ require 'vendor/autoload.php';

use EC2SnapshotManagement\Manager;

$manager = new Manager;

// Cleanup existing snapshots
$manager->cleanupSnapshots('vol-abcdefij', 'eu-west-1', false, true, true);
// OR no arguments if calling this script from the command line
/**
* Create a new EC2 Snapshot Manager
*
* You don't need to supply any arguments if calling from the command line.
*
* @param string $volume EC2 Volume Identifier
* @param string $region EC2 Region Identifier
* @param boolean $quiet Quiet mode, no output
* @param boolean $noOperation No operation mode, nothing will get deleted
* @param boolean $verbose Verbose, tells you exactly what it's doing
* @param string $description Description of new snapshot if creating one
*/
$manager = new Manager('vol-abcdefgh', 'eu-west-1', false, true, true, 'My Data Backup');

/**
* Cleans up existing old snapshots
*/
$manager->cleanupSnapshots();

// Create a new snapshot
$manager->takeSnapshot('vol-abcdefgh', 'eu-west-1', false, true, true, 'My Server Backup');
// OR no arguments if calling this script from the command line
/**
* Take a new snapshot
*/
$manager->takeSnapshot();
```

Expand Down

0 comments on commit f6d0c12

Please sign in to comment.