Update documentation

Author: yoanm

README.md

@@ -11,17 +11,18 @@ Symfony JSON-RPC HTTP Server to convert an HTTP json-rpc request into HTTP json-
 
 ## How to use
 
-You can either use this library as a simple extension or like any symfony bundle.
-
+Bundle requires only two things : 
+ - A method resolver which is compatible with [`yoanm/jsonrpc-server-sdk`](https://raw.githubusercontent.com/yoanm/php-jsonrpc-server-sdk)
+ - JSON-RPC Methods which are compatible with [`yoanm/jsonrpc-server-sdk`](https://raw.githubusercontent.com/yoanm/php-jsonrpc-server-sdk)
+ 
 *[Behat demo app configuration folders](./features/demo_app/) can be used as examples.*
 
-### With Symfony bundle
-
  - Add the bundles in your `config/bundles.php` file:
    ```php
    // config/bundles.php
    return [
        ...
+       Symfony\Bundle\FrameworkBundle\FrameworkBundle::class => ['all' => true],
        Yoanm\SymfonyJsonRpcHttpServer\JsonRpcHttpServerBundle::class => ['all' => true],
        ...
    ];
@@ -37,138 +38,39 @@ You can either use this library as a simple extension or like any symfony bundle
  - Add the following in your configuration :
    ```yaml
    # config/config.yaml
-   json_rpc_http_server: ~
-   ```
+   framework:
+     secret: '%env(APP_SECRET)%'
 
-### With Symfony extension only
- - Load the extension in your kernel :
-   ```php
-   // src/Kernel.php
-   ...
-   use Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait;
-   use Yoanm\SymfonyJsonRpcHttpServer\DependencyInjection\JsonRpcHttpServerExtension;
-   ...
-   class Kernel
-   {
-       use MicroKernelTrait;
-       ....
-       /**
-       * {@inheritdoc}
-       */
-      protected function configureContainer(ContainerBuilder $container, LoaderInterface $loader)
-      {
-          /**** Add and load extension **/
-          $container->registerExtension($extension = new JsonRpcHttpServerExtension());
-          // If you use Symfony Config component, add "json_rpc_http_server: ~" in your configuration.
-          // Else load it there
-          $container->loadFromExtension($extension->getAlias());
-          
-          ...
-      }
-       ....
-   }
+   json_rpc_http_server: ~
+   # Or the following in case you want to customize endpoint path
+   #json_rpc_http_server:
+   #  endpoint: '/my-custom-endpoint'
    ```
-   
- - Map your your JSON-RPC methods, see **JSON-RPC Method mapping** section below
- - Manually configure an endpoint, see **Routing** section below
 
 ## JSON-RPC Method mapping
-You have many ways to inject you json-rpc methods :
- - If you use the bundle, you can do it by configuration :
-   ```yaml
-   # config/config.yaml
-   json_rpc_http_server:
-       methods_mapping:
-           method-a: '@method-a.service-id'
-           method-b: 
-               service: '@method-b.service-id'
-               aliases: 'method-b-alias'
-           method-c: 
-               service: '@method-c.service-id'
-               aliases: ['method-c-alias-1', 'method-c-alias-2']
-   ```
- - You can use tag in the service definition as below :
-   ```yaml
-   services:
-     method-a.service-id:
-       class: Method\A\Class
-       public: true # <= do no forget the set visibility to public !
-       tags:
-         - { name: 'json_rpc_http_server.jsonrpc_method', method: 'method-a' }
-         - { name: 'json_rpc_http_server.jsonrpc_method', method: 'method-a-alias' }
-   ```
- - Inject manually your mapping during container building
-   ```php
-   // src/Kernel.php
-   ...
-   use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
-   use Yoanm\SymfonyJsonRpcHttpServer\DependencyInjection\JsonRpcHttpServerExtension;
-   ...
-   class Kernel implements CompilerPassInterface
-   {
-       ....
-       /**
-        * {@inheritdoc}
-        */
-       public function process(ContainerBuilder $container)
-       {
-           $container->getDefinition(JsonRpcHttpServerExtension::SERVICE_NAME_RESOLVER_SERVICE_NAME)
-               ->addMethodCall('addMethodMapping', ['method-a', 'method-a.service-id'])
-               ->addMethodCall('addMethodMapping', ['method-b', 'method-b.service-id'])
-               ->addMethodCall('addMethodMapping', ['method-b-alias', 'method-b.service-id'])
-           ;
-       }
-       ....
-   }
-   ```
- - Or inject manually your mapping after container building
-   ```php
-   $container->get(JsonRpcHttpServerExtension::SERVICE_NAME_RESOLVER_SERVICE_NAME)
-       ->addMethodMapping('method-a', 'method-a.service-id')
-       ->addMethodMapping('method-b', 'method-b.service-id')
-       ->addMethodMapping('method-b-alias', 'method-b.service-id')
-   ;
-   ```
- 
-## Routing
- - If you use the bundle, the default endpoint is `/json-rcp`. You can custome it by using : 
-   ```yaml
-   # config/config.yaml
-   json_rpc_http_server: 
-       endpoint: '/my-custom-endpoint'
-   ```
-   
- - Or you can define your own route and bind the endpoint as below :
-   ```yaml
-   # config/routes.yaml
-   index:
-       path: /my-json-rpc-endpoint
-       defaults: { _controller: 'json_rpc_http_server.endpoint:index' }
-   ```
-   
-## Custom method resolver
+In order to inject yours JSON-RPC method into the server add the tag `json_rpc_http_server.jsonrpc_method` and the key/value `method` like following example :
+```yaml
+services:
+   method-a.service-id:
+      class: Method\A\Class
+      tags:
+       - { name: 'json_rpc_http_server.jsonrpc_method', method: 'method-a' }
+       - { name: 'json_rpc_http_server.jsonrpc_method', method: 'method-a-alias' }
+```
 
-By default this bundle use [`yoanm/jsonrpc-server-sdk-psr11-resolver`](https://github.com/yoanm/php-jsonrpc-server-sdk-psr11-resolver).
+   
+## Method resolver
 
-In case you want to use your own, you can do it by using : 
+A method resolver is required, you can either use [`yoanm/symfony-jsonrpc-server-psr11-resolver`](https://github.com/yoanm/symfony-jsonrpc-server-psr11-resolver) or write your own
 
-### Service definition tag
-Use `json_rpc_http_server.method_resolver` tag as following:
+In case you want to use your own, it will be automatically injected if you use the tag `json_rpc_http_server.method_resolver` :
 ```yaml
 services:
   my.custom_method_resolver.service:
     class: Custom\Method\Resolver\Class
     tags: ['json_rpc_http_server.method_resolver']
 ```
 
-### Bundle configuration
-Configure the bundle as below
-```yaml
-# config/config.yaml
-json_rpc_http_server:
-    method_resolver: '@my.custom_method_resolver.service'
-```
-   
 
 ## Contributing
 See [contributing note](./CONTRIBUTING.md)