From f5af7eff80d8e970f15b517d620e66bf676892ee Mon Sep 17 00:00:00 2001 From: Sebastian Meyer Date: Fri, 24 Jan 2020 01:15:04 +0100 Subject: [PATCH] Update documentation --- Configuration/Main.php | 4 +++- README.md | 10 +++++----- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/Configuration/Main.php b/Configuration/Main.php index 488671c..96436e4 100644 --- a/Configuration/Main.php +++ b/Configuration/Main.php @@ -59,7 +59,9 @@ $config = [ // Directory containing the records // // Make sure the given path is readable and there is a subdirectory for every - // 'metadataPrefix' you specified above. + // 'metadataPrefix' you specified above. Although the given example points to + // a directory inside the document root it is highly recommended to place the + // data directory somewhere else. This will make upgrading so much easier! 'dataDirectory' => './Data/', // Maximum number of records to return before giving a resumption token diff --git a/README.md b/README.md index 5590c36..74f3abf 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ A demo installation can be found [here](https://demo.opencultureconsulting.com/o ## Installation -1. Deploy all the files to a webserver. +1. Run `composer create-project opencultureconsulting/oai_pmh `. 2. Edit `Configuration/Main.php` and adjust the settings according to your preferences. @@ -22,13 +22,13 @@ A demo installation can be found [here](https://demo.opencultureconsulting.com/o ## Upgrading -1. Backup all data (especially `Configuration/Main.php`)! +1. Backup `Configuration/Main.php` and your data directory! -2. Replace all files except your data directory with the new release. +2. Delete everything and re-install by running `composer create-project opencultureconsulting/oai_pmh `. -3. Move your configuration back into `Configuration/Main.php`. +3. Move your configuration back into `Configuration/Main.php` and restore your data directory. -4. Congratulations! Now you are running a new version of the Simple OAI-PMH 2.0 Data Provider. You can access the entry point by calling `index.php?verb=Identify` in your browser. +4. Congratulations! Now you are running the newest version of the Simple OAI-PMH 2.0 Data Provider. You can access the entry point by calling `index.php?verb=Identify` in your browser. ## Updating