Setup guide

README.md

@@ -13,19 +13,16 @@ This plugin requires Craft CMS 3.0.0-RC4 or later.
 
 To install the plugin, follow these instructions.
 
-1. Open your terminal and go to your Craft project:
+
+**1. Intall the plugin via composer**
 
 ```
 cd /path/to/project
-```
-
-2. Then tell Composer to load the plugin:
 
-```
 composer require fortrabbit/craft-object-storage
 ```
 
-3. Update your local .env file 
+**2. Update your local .env file** 
 
 Learn how to [access credentials](https://help.fortrabbit.com/object-storage#toc-obtaining-credentials) on fortrabbit.
 
@@ -39,7 +36,17 @@ OBJECT_STORAGE_SERVER="objects.(us1|eu2).frbit.com"
 OBJECT_STORAGE_URL="https://(YOUR_APP_NAME).objects.frb.io"
 ```
 
-4. Install the plugin
+**3. Install the plugin**
+```
+./craft install/plugin fortrabbit-object-storage
+```
+
+Or browse to  CP > Settings > Plugins to enable the plugin.
+
+
+**4. Configure**
+
+The plugin creates a config `volumes.php` file in `/path/to/project/config/`. This is the place to configure your Volumes.
+To apply the changes you need to "Sync" the changes in the CP, under Settings > Assets.
 
-Execute the this command `./craft install/plugin fortrabbit-object-storage` in your terminal to install the plugin or in the Craft CP under Settings > Plugins
 

src/Plugin.php

@@ -28,7 +28,7 @@ class Plugin extends \craft\base\Plugin
      * @var Plugin
      */
     public static $plugin;
-    
+
     /**
      * @inheritdoc
      */