diff --git a/README.md b/README.md index df01ff7..095e8fe 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,33 @@ # phpbb_updates -Shell Script to update phpBB to current version. +Shell Script to update phpBB to current version. + + +Usage: + +Switch into you current phpBB root directory, then + +`git clone https://git.24unix.net/tracer/phpbb_updates.git` + +Or download either: +https://git.24unix.net/tracer/phpbb_updates/archive/v0.0.1.zip + +or: +https://git.24unix.net/tracer/phpbb_updates/archive/v0.0.1.tar.gz + +and unpack them into the same directory and change into phpbb_updates. + +Then: Install composer (https://getcomposer.org/download/) and run +`composer install` + +followed by: +`php update.php` + +If you are using KeyHelp, replace + +`composer install` with `keyhelp-php81 composer install` +and +`php update.php` with `keyhelp-php81 update.php` + + +