documentation and tidying up

README.md

@@ -13,3 +13,26 @@ telsa_blizzard_connection:
     client_secret: ~
 ```
 
+### General Usage
+
+```php
+// create your desired API connection
+$api = $this->get('telsa_blizzard_connection.apis.world_of_warcraft.character_profile_api');
+
+// set the region
+$api->setRegion('eu');
+
+// set the required params
+$api->setCharacterName('Pillaren');
+$api->setRealm('the-venture-co');
+
+// call the desired endPoint
+$char = $api->getCharacter();
+
+// call with any required extra details
+$char = $api->getCharacter(['professions', 'mounts', 'talents']);
+
+// some helper functions. eg.
+$charWithMounts = $api->getCharacterMounts();
+$charWithTalents = $api->getCharacterTalents();
+```

src/DependencyInjection/Configuration.php

@@ -13,7 +13,7 @@ public function getConfigTreeBuilder()
         $rootNode = $treeBuilder->root('telsa_blizzard_connection');
 
         $rootNode->children()
-            ->scalarNode('client_id')->end()
+            ->scalarNode('client_id')->info('Required for connection Blizzard API')->end()
             ->scalarNode('client_secret')->end()
             ->end();
 

src/Resources/config/services.yml

@@ -1,9 +1,5 @@
 # Learn more about services, parameters and containers at
 # https://symfony.com/doc/current/service_container.html
-parameters:
-    telsa_blizzard_connection.client_id:
-    telsa_blizzard_connection.client_secret:
-
 services:
 
     telsa_blizzard_connection.apis.world_of_warcraft.character_profile_api: