update documentation

heybigname · Jan 30, 2015 · 11fe3c0 · 11fe3c0
1 parent 1b3fe7f
commit 11fe3c0
Show file tree

Hide file tree

Showing 2 changed files with 70 additions and 55 deletions.
diff --git a/README.md b/README.md
@@ -29,7 +29,7 @@ This package is completely framework agnostic. Mitchell has put together a [vide
 
 ### Stability Notice
 
-This isn't a `1.0` release.
+It's stable enough, you'll need to understand permissions.
 
 This package is actively being developed and we would like to get feedback to improve it. [Please feel free to submit feedback.](https://github.com/heybigname/backup-manager/issues/new)
 
@@ -149,6 +149,22 @@ Run the following to include this via Composer
 composer require heybigname/backup-manager
 ```
 
+Then, you'll need to select the appropriate packages for the adapters that you want to use.
+
+```shell
+# to support s3
+composer require league/flysystem-aws-s3-v2
+
+# to support dropbox
+composer require league/flysystem-dropbox
+
+# to support rackspace
+composer require league/flysystem-rackspace
+
+# to support sftp
+composer require league/flysystem-sftp
+```
+
 ### Usage
 
 Once installed, the package must be bootstrapped (initial configuration) before it can be used. If you're using Laravel then skip directly to the [Laravel integration section](#laravel).
@@ -182,8 +198,7 @@ The Backup Manager will make use of Laravel's database configuration.
 ```php
 use BigName\BackupManager\Manager;
 
-public function __construct(Manager $manager)
-{
+public function __construct(Manager $manager) {
     $this->manager = $manager;
 }
 ```

diff --git a/composer.json b/composer.json
@@ -1,56 +1,56 @@
 {
-    "name": "heybigname/backup-manager",
-    "description": "Database backup manager for dumping to and restoring databases from S3, Dropbox, FTP, and SFTP.",
-    "authors": [
-        {
-            "name": "Shawn McCool",
-            "email": "shawn@heybigname.com",
-            "homepage": "http://heybigname.com/"
-        },
-        {
-            "name": "Mitchell van Wijngaarden",
-            "email": "mitchell@kooding.nl",
-            "homepage": "http://heybigname.com/"
-        }
-    ],
-    "require": {
-        "php": ">=5.4.0",
-        "symfony/process": "2.*",
-        "aws/aws-sdk-php": "~2.4",
-        "league/flysystem": "~1.0"
+  "name": "heybigname/backup-manager",
+  "description": "Database backup manager for dumping to and restoring databases from S3, Dropbox, FTP, and SFTP.",
+  "authors": [
+    {
+      "name": "Shawn McCool",
+      "email": "shawn@heybigname.com",
+      "homepage": "http://heybigname.com/"
     },
-    "require-dev": {
-        "mockery/mockery": "dev-master",
-        "satooshi/php-coveralls": "~0.6",
-        "illuminate/support": "4.x",
-        "illuminate/container": "4.x",
-        "illuminate/console": "4.x",
-	"league/flysystem-aws-s3-v2" : "~1.0",
-	"league/flysystem-dropbox": "~1.0",
-	"league/flysystem-rackspace": "~1.0",
-	"league/flysystem-sftp": "~1.0",
-        "dropbox/dropbox-sdk": "1.1.*",
-        "phpspec/phpspec": "~2.1"
-    },
-    "config": {
-        "bin-dir": "bin"
-    },
-    "suggest": {
-        "league/flysystem-aws-s3-v2": "AwsS3 adapter support.",
-        "league/flysystem-dropbox": "Dropbox adapter support.",
-        "league/flysystem-rackspace": "Rackspace adapter support.",
-        "league/flysystem-sftp": "Sftp adapter support."
-    },
-    "autoload": {
-        "psr-4": {
-            "BigName\\BackupManager\\": "src/"
-        }
-    },
-    "license": "MIT",
-    "minimum-stability": "dev",
-    "extra": {
-        "branch-alias": {
-            "dev-master": "0.3-dev"
-        }
+    {
+      "name": "Mitchell van Wijngaarden",
+      "email": "mitchell@kooding.nl",
+      "homepage": "http://heybigname.com/"
+    }
+  ],
+  "require": {
+    "php": ">=5.4.0",
+    "symfony/process": "2.*",
+    "aws/aws-sdk-php": "~2.4",
+    "league/flysystem": "~1.0"
+  },
+  "require-dev": {
+    "mockery/mockery": "dev-master",
+    "satooshi/php-coveralls": "~0.6",
+    "illuminate/support": "4.x",
+    "illuminate/container": "4.x",
+    "illuminate/console": "4.x",
+    "league/flysystem-aws-s3-v2": "~1.0",
+    "league/flysystem-dropbox": "~1.0",
+    "league/flysystem-rackspace": "~1.0",
+    "league/flysystem-sftp": "~1.0",
+    "dropbox/dropbox-sdk": "1.1.*",
+    "phpspec/phpspec": "~2.1"
+  },
+  "config": {
+    "bin-dir": "bin"
+  },
+  "suggest": {
+    "league/flysystem-aws-s3-v2": "AwsS3 adapter support.",
+    "league/flysystem-dropbox": "Dropbox adapter support.",
+    "league/flysystem-rackspace": "Rackspace adapter support.",
+    "league/flysystem-sftp": "Sftp adapter support."
+  },
+  "autoload": {
+    "psr-4": {
+      "BigName\\BackupManager\\": "src/"
+    }
+  },
+  "license": "MIT",
+  "minimum-stability": "dev",
+  "extra": {
+    "branch-alias": {
+      "dev-master": "0.3-dev"
     }
+  }
 }