Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jdelaune committed Feb 28, 2015
1 parent 7ac39e7 commit 1f4027d
Showing 1 changed file with 5 additions and 10 deletions.
15 changes: 5 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
CONTENTS OF THIS FILE
---------------------
# EC2 Snapshot Management

* [Introduction](#introduction)
* [Installation](#installation)
* [Example](#example)
* [Command Line Parameters](#command-line-parameters)


INTRODUCTION
------------
## Introduction

AWS EC2 Snapshot Management is a php script which prunes EC2 snapshots as if they were backups. It's meant to be run from the command line, but can be called by other PHP scripts if you so desire. As well as cleaning up snapshots it can also be used to take new snapshots as well.

Expand All @@ -25,8 +23,7 @@ This script took inspiration from 'EC2 Manage Snapshots' made by Erik Dasque and
This script is provided under the MIT License.


INSTALLATION
------------
## Installation

Use Composer by adding this requirement to your existing `composer.json` file or by creating one and adding this:

Expand All @@ -47,8 +44,7 @@ http://docs.aws.amazon.com/aws-sdk-php/guide/latest/credentials.html#credential-
It expects a profile called `ec2snapshot`.


EXAMPLE
-------
## Example

You will need to create a sample script like the one below:

Expand Down Expand Up @@ -94,8 +90,7 @@ php myScript.php -v=vol-abcdefgh -r=eu-west-1 -d="My Server Backup" -n -o
You will probably want to create two scripts to call each function independently!


COMMAND LINE PARAMETERS
-----------------------
## Command line parameters

Parameter | Value
--------- | -------------------------
Expand Down

0 comments on commit 1f4027d

Please sign in to comment.