Skip to content

Commit

Permalink
Update docs, add .env example.
Browse files Browse the repository at this point in the history
  • Loading branch information
judgej committed Feb 25, 2018
1 parent 3a30e52 commit 48aa3e1
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 4 deletions.
4 changes: 4 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Azure file storage
AZURE_FLE_STORAGE_ACCOUNT="youraccountname"
AZURE_FLE_STORAGE_ACCESS_KEY="very-long-access-key-here"
AZURE_FLE_STORAGE_SHARE_NAME="name-files-are-shared-to"
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
# Azure File Storage Filesystem Driver for Laravel 5

Still under development, but fundtional.

## Installation

TODO: Laravel 5.5+ and earlier versions.

## Configuration in `config/filesystems.php`:

Expand All @@ -6,9 +13,9 @@
...
'disks' => [
...
// Call this disk what you like.
// Name this disk for your application to reference.
'azure-file-storage' => [
// This driver.
// The driver provided by this package.
'driver' => 'azure-file-storage',

// Account credentials.
Expand All @@ -18,7 +25,7 @@
// The file share.
// This driver supports one file share at a time (you cannot
// copy or move files between shares natively).
'fileShareName' => env('AZURE_FLE_STORAGE_HARE_NAME'),
'fileShareName' => env('AZURE_FLE_STORAGE_SHARE_NAME'),

// Optional settings
'disableRecursiveDelete' => false,
Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "academe/laravel-azure-file-storage-driver",
"description": "Azure File Storage filesystem driver for Laravel.",
"description": "Azure File Storage filesystem driver for Laravel",
"homepage": "https://github.com/academe",
"license": "MIT",
"authors": [
Expand Down

0 comments on commit 48aa3e1

Please sign in to comment.