From f6d0c1234940ff05a183e3d9b8d0ef6777b9d9a1 Mon Sep 17 00:00:00 2001 From: Jordan de Laune Date: Sat, 28 Feb 2015 19:15:36 +0000 Subject: [PATCH] Updated readme --- README.md | 28 ++++++++++++++++++++-------- 1 file changed, 20 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index a416ff6..19cc062 100644 --- a/README.md +++ b/README.md @@ -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(); ```