JeroenED/libpairtwo
1
0
Fork 0
mirror of https://github.com/JeroenED/libpairtwo.git synced 2024-12-22 12:21:22 +01:00
Code Issues Projects Releases Wiki Activity

Updated dist/readme with update instructions

Browse Source
This commit is contained in:
Jeroen De Meerleer 2019-06-20 23:28:58 +02:00
parent 0bf6df478e
commit 659bc0545a
Signed by: JeroenED
GPG Key ID: 28CCCB8F62BFADD6
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
dist/readme.md vendored
View File

@ -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