diff --git a/filesystem.md b/filesystem.md
index 9c1ced9ab6c..4f98c4be6cd 100644
--- a/filesystem.md
+++ b/filesystem.md
@@ -3,6 +3,11 @@
- [Introduction](#introduction)
- [Configuration](#configuration)
- [Basic Usage](#basic-usage)
+ - [Obtaining Disk Instances](#obtaining-disk-instances)
+ - [Retrieving Files](#retrieving-files)
+ - [Storing Files](#storing-files)
+ - [Deleting Files](#deleting-files)
+ - [Directories](#directories)
- [Custom Filesystems](#custom-filesystems)
@@ -13,17 +18,17 @@ Laravel provides a powerful filesystem abstraction thanks to the wonderful [Flys
## Configuration
-The filesystem configuration file is located at `config/filesystems.php`. Within this file you may configure all of your "disks". Each disk represents a particular storage driver and storage location. Example configurations for each supported driver is included in the configuration file. So, simply modify the configuration to reflect your storage preferences and credentials!
+The filesystem configuration file is located at `config/filesystems.php`. Within this file you may configure all of your "disks". Each disk represents a particular storage driver and storage location. Example configurations for each supported driver is included in the configuration file. So, simply modify the configuration to reflect your storage preferences and credentials.
Of course, you may configure as many disks as you like, and may even have multiple disks that use the same driver.
-### The Local Driver
+#### The Local Driver
When using the `local` driver, note that all file operations are relative to the `root` directory defined in your configuration file. By default, this value is set to the `storage/app` directory. Therefore, the following method would store a file in `storage/app/file.txt`:
Storage::disk('local')->put('file.txt', 'Contents');
-### Other Driver Prerequisites
+#### Other Driver Prerequisites
Before using the S3 or Rackspace drivers, you will need to install the appropriate package via Composer:
@@ -33,7 +38,10 @@ Before using the S3 or Rackspace drivers, you will need to install the appropria
## Basic Usage
-The `Storage` facade may be used to interact with any of your configured disks. For example, to store an avatar on the default "disk":
+
+### Obtaining Disk Instances
+
+The `Storage` facade may be used to interact with any of your configured disks. For example, you may use the `put` method on the facade to store an avatar on the default disk. If you call methods on the `Storage` facade without first calling the `disk` method, the method call will automatically be passed to the default disk:
get('file.jpg')
+
+
+### Retrieving Files
+
+The `get` method may be used to retrieve the contents of a given file. The raw string contents of the file will be returned by the method:
-#### Determining If A File Exists
+ $contents = Storage::get('file.jpg');
+
+The `exists` method may be used to determine if a given file exists on the disk:
$exists = Storage::disk('s3')->exists('file.jpg');
-#### Calling Methods On The Default Disk
+#### File Meta Information
-If you call methods on the `Storage` facade without first calling the `disk` method, the method call will automatically be passed to the default disk:
+The `size` method may be used to get the size of the file in bytes:
- if (Storage::exists('file.jpg')) {
- //
- }
+ $size = Storage::size('file1.jpg');
-#### Retrieving A File's Contents
+The `lastModified` method returns the UNIX timestamp of the last time the file was modified:
- $contents = Storage::get('file.jpg');
+ $time = Storage::lastModified('file1.jpg');
-#### Setting A File's Contents
+
+### Storing Files
- Storage::put('file.jpg', $contents);
+The `put` method may be used to store a file on disk. You may also pass a PHP `resource` to the `put` method, which will use Flysystem's underlying stream support. Using streams is greatly recommended when dealing with large files:
-#### Prepend To A File
+ Storage::put('file.jpg', $contents);
- Storage::prepend('file.log', 'Prepended Text');
+ Storage::put('file.jpg', $resource);
-#### Append To A File
+The `copy` method may be used to move an existing file to a new location on the disk:
- Storage::append('file.log', 'Appended Text');
+ Storage::copy('old/file1.jpg', 'new/file1.jpg');
-#### Delete A File
+The `move` method may be used to move an existing file to a new location:
- Storage::delete('file.jpg');
+ Storage::move('old/file1.jpg', 'new/file1.jpg');
- Storage::delete(['file1.jpg', 'file2.jpg']);
+#### Prepending / Appending To Files
-#### Copy A File To A New Location
+The `prepend` and `append` methods allow you to easily insert content at the beginning or end of a file:
- Storage::copy('old/file1.jpg', 'new/file1.jpg');
+ Storage::prepend('file.log', 'Prepended Text');
-#### Move A File To A New Location
+ Storage::append('file.log', 'Appended Text');
- Storage::move('old/file1.jpg', 'new/file1.jpg');
+
+### Deleting Files
-#### Get File Size
+The `delete` method accepts a single filename or an array of files to remove from the disk:
- $size = Storage::size('file1.jpg');
+ Storage::delete('file.jpg');
-#### Get The Last Modification Time (UNIX)
+ Storage::delete(['file1.jpg', 'file2.jpg']);
- $time = Storage::lastModified('file1.jpg');
+
+### Directories
#### Get All Files Within A Directory
+The `files` method returns an array of all of the files in a given directory. If you would like to retrieve a list of all files within a given directory including all sub-directories, you may use the `allFiles` method:
+
$files = Storage::files($directory);
- // Recursive...
$files = Storage::allFiles($directory);
#### Get All Directories Within A Directory
+The `directories` method returns an array of all the directories within a given directory. Additionally, you may use the `allDirectories` method to get a list of all directories within a given directory and all of its sub-directories:
+
$directories = Storage::directories($directory);
// Recursive...
@@ -135,10 +152,14 @@ If you call methods on the `Storage` facade without first calling the `disk` met
#### Create A Directory
+The `makeDirectory` method will create the given directory, including any needed sub-directories:
+
Storage::makeDirectory($directory);
#### Delete A Directory
+Finally, the `deleteDirectory` may be used to remove a directory, including all of its files, from the disk:
+
Storage::deleteDirectory($directory);