From 7d8c958d17cc28e61644f58fd3b56698d186d0e7 Mon Sep 17 00:00:00 2001 From: Jeroen De Meerleer Date: Thu, 20 Jun 2019 23:31:19 +0200 Subject: [PATCH] ENHANCEMENT: Added update section to dist/readme.md --- CHANGELOG.md | 1 + dist/composer-dist-installed.json | 2 +- dist/readme.md | 11 +++++++++++ 3 files changed, 13 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0f889d3..cd986a2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,7 @@ # CHANGELOG ## v1.1.2 (Release: 21-jun-2019) +* ENHANCEMENT: Added update section to dist/readme.md * MAJOR BUGFIX: `Game::GetResult` throws fatal error `Cannot access parent:: when current class scope has no parent` ## v1.1.1 (Released: 20-jun-2019) diff --git a/dist/composer-dist-installed.json b/dist/composer-dist-installed.json index beccd86..0528983 100644 --- a/dist/composer-dist-installed.json +++ b/dist/composer-dist-installed.json @@ -1,5 +1,5 @@ { "require": { - "jeroened/libpairtwo": "^1.0" + "jeroened/libpairtwo": "^1.1" } } \ No newline at end of file diff --git a/dist/readme.md b/dist/readme.md index 70875ff..4ee9f45 100644 --- a/dist/readme.md +++ b/dist/readme.md @@ -9,6 +9,14 @@ The other variable (`$pairingfileformat`) is a variable that defines the format Below the comments you'll find some example code. This code is only a aggregation of several fields that are read out. If you need any modifications like putting the rankings in a table or you want to just write it to a file, go ahead it's all yours. +How to update the library? +-------------------------- +If you want to upgrade the library to a new version of it you just need to remove the vendor direcotry and upload the updated one. + +I definitely say to remove it because simply overwriting might cause problems because residual files. + +You might want to re-upload the file composer.json as well as this file might have been changed as well. However, it probably won't change a lot and can be safely ignored if you don't need other dependencies. + What if I need other dependencies? ---------------------------------- If you started to ask yourself this question, you'll probably know what composer and dependency management is? Therefore this section will become a little more advanced than the ones above. @@ -20,3 +28,6 @@ If you already have a project with other dependencies you'll only want to copy t $ composer require jeroened/libpairtwo +If you want to update the libary while having other dependencies, you'll definitely don't want to remove vendor directory or composer.json file. The vendor folder contains these other dependencies and the composer.json contains the definitions of these dependencies. To update the library you only need to launch the update command. + + $ composer update jeroened/libpairtwo