Merge pull request #2 from Simonsator/composer

Composer

Author: Simonsator

.gitignore

@@ -46,3 +46,7 @@ Temporary Items
 .metadata/*
 .recommenders/*
 .idea/*
+
+# Composer
+vendor/
+composer.lock

.phpstorm.meta.php

@@ -5,7 +5,6 @@
 	// injections will have the following replacement rules.
 		sql_injection_subst(),
 		map([
-			'{' => "fr_", // all `{` in injected SQL strings will be replaced with a prefix
-			'}' => '',        // all `}` will be replaced with an empty string
+			'{$this->getTablePrefix()}' => 'fr_',
 		]));
 }

PAFLib/PAFPlayer.php

@@ -1,12 +1,47 @@
 # PHP API for Party and Friends
-A library for Party and Friends ([the free version for BungeeCord](https://www.spigotmc.org/resources/party-and-friends-for-bungeecord.9531/), [the extended version for Bungeecord](https://www.spigotmc.org/resources/party-and-friends-extended-for-spigot-supports-1-7-1-16-5.11633/) and [the extended version for Spigot](https://www.spigotmc.org/resources/party-and-friends-extended-for-spigot-supports-1-7-1-16-5.11633/)) to use its data in PHP scripts.
+
+A PHP composer library for Party And
+Friends ([Free for Bungeecord](https://www.spigotmc.org/resources/party-and-friends-for-bungeecord-supports-1-7-x-to-1-19-x.9531/)
+, [Extended For Bungeecord/Velocity](https://www.spigotmc.org/resources/party-and-friends-extended-edition-for-bungeecord-velocity-supports-1-7-1-19.10123/)
+, [Extended For Spigot](https://www.spigotmc.org/resources/party-and-friends-extended-for-spigot-supports-1-7-1-19.11633/) (
+you need to use MySQL as a data source),
+or [Free For Velocity](https://forums.papermc.io/threads/party-and-friends-for-velocity-version-1-0-89.317/)), which
+allows developers to access Party And Friends data in PHP.
+
 ## Requirements
-* PHP 7.4 or later
-* An installation of Party and Friends ([the free version for BungeeCord](https://www.spigotmc.org/resources/party-and-friends-for-bungeecord.9531/), [the extended version for Bungeecord](https://www.spigotmc.org/resources/party-and-friends-extended-for-spigot-supports-1-7-1-16-5.11633/) or [the extended version for Spigot](https://www.spigotmc.org/resources/party-and-friends-extended-for-spigot-supports-1-7-1-16-5.11633/)) with MySQL used as database
+
+* PHP 7.4 or higher
+* [Composer](https://getcomposer.org/)
+* A MySQL server containing the Party And
+  Friends ([Free for Bungeecord](https://www.spigotmc.org/resources/party-and-friends-for-bungeecord-supports-1-7-x-to-1-19-x.9531/)
+  , [Extended For Bungeecord/Velocity](https://www.spigotmc.org/resources/party-and-friends-extended-edition-for-bungeecord-velocity-supports-1-7-1-19.10123/)
+  , [Extended For Spigot](https://www.spigotmc.org/resources/party-and-friends-extended-for-spigot-supports-1-7-1-19.11633/) (
+  you need to use MySQL as a data source),
+  or [Free For Velocity](https://forums.papermc.io/threads/party-and-friends-for-velocity-version-1-0-89.317/)) data
+  which should be accessed
 
 ## Installation
-* Put this library into your web directory folder 
-* Enter your MySQL data into the "PAFLib/config.php" file
-* Test if everything works by opening the website %YOUR_HOST%/PAFLib/test/index.php
+
+Add the following lines to your composer file:
+
+```json
+{
+  "repositories": [
+    {
+      "type": "vcs",
+      "url": "https://github.com/Simonsator/PartyAndFriends-PHP-Lib"
+    }
+  ],
+  "require": {
+    "simonsator/party-and-friends-php-lib": "@dev"
+  }
+}
+```
+
 ## Where to start
-If you don't know how to use this library have a look at the ["test/index.php"](https://github.com/Simonsator/PartyAndFriends-PHP-Lib/blob/master/PAFLib/test/index.php) and ["test/playerdatashow.php"](https://github.com/Simonsator/PartyAndFriends-PHP-Lib/blob/master/PAFLib/test/playerdatashow.php)
+
+A demo project can be found [here](https://github.com/Simonsator/PartyAndFriends-PHP-Lib-Demo). To get started, you
+should call the constructor of the class `Simonsator\PartyAndFriends\PAFPlayerManager`. You need to provide the table
+prefix used by Party And Friends and a PDO object with an active connection to the MySQL database which is used by Party
+And Friends. Using the methods of the `PAFPlayerManager` you can `PAFPlayer` objects, with which you can access data of
+players.