From 999dd545baf0822530c0675974d4763d5df2c877 Mon Sep 17 00:00:00 2001 From: Mike Bryant Date: Wed, 19 Apr 2023 15:00:18 +0100 Subject: [PATCH] Tweak README --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a768c39..0f460d6 100644 --- a/README.md +++ b/README.md @@ -14,9 +14,9 @@ The main differences are: ## Usage -1. Download repo as a zip file and extract it to a folder named `AmazonS3StorageAdapter` in the `plugins` directory in your Omeka instance. -2. Run `composer install` within the plugin's folder to install the Amazon S3 PHP SDK. -3. Enable the plugin in admin/plugins +1. Download the latest [release](https://github.com/EHRI/omeka-amazon-s3-storage-adapter/releases) from GitHub +2. Extract it to the Omeka `plugins` directory +3. Enable the `AmazonS3StorageAdapter` plugin in admin/plugins 4. Add the following to your Omeka `application/configuration/config.ini` file: ``` @@ -27,6 +27,14 @@ storage.adapterOptions.bucket = my-bucket-name storage.adapterOptions.region = eu-central-1 ``` +(Being sure to set the correct bucket name and region, in addition to your access key and secret.) + +To run the latest code from GitHub, rather than the last release: + +1. Download repo as a zip file +2. Extract it to a folder named `AmazonS3StorageAdapter` in the plugins directory in your Omeka instance +3. Run `composer install` within the plugin's folder to install the Amazon S3 PHP SDK + *Note*: including the AWS SDK makes this plugin package very large since there is currently no way to depend on _just_ the S3-related parts. This will hopefully be remedied in future.