Documentation (#8)

Author: yoanm

README.md

@@ -1,4 +1,4 @@
-# JSON-RPC params validator bundle
+# Symfony JSON-RPC params documentation
 [![License](https://img.shields.io/github/license/yoanm/symfony-jsonrpc-params-sf-constraints-doc.svg)](https://github.com/yoanm/symfony-jsonrpc-params-sf-constraints-doc) [![Code size](https://img.shields.io/github/languages/code-size/yoanm/symfony-jsonrpc-params-sf-constraints-doc.svg)](https://github.com/yoanm/symfony-jsonrpc-params-sf-constraints-doc) [![Dependencies](https://img.shields.io/librariesio/github/yoanm/symfony-jsonrpc-params-sf-constraints-doc.svg)](https://libraries.io/packagist/yoanm%2Fsymfony-jsonrpc-params-sf-constraints-doc)
 
 [![Scrutinizer Build Status](https://img.shields.io/scrutinizer/build/g/yoanm/symfony-jsonrpc-params-sf-constraints-doc.svg?label=Scrutinizer&logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/symfony-jsonrpc-params-sf-constraints-doc/build-status/master) [![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/yoanm/symfony-jsonrpc-params-sf-constraints-doc/master.svg?logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/symfony-jsonrpc-params-sf-constraints-doc/?branch=master) [![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/yoanm/symfony-jsonrpc-params-sf-constraints-doc/master.svg?logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/symfony-jsonrpc-params-sf-constraints-doc/?branch=master)
@@ -9,8 +9,36 @@
 
 Symfony bundle for easy Symfony constraints to JSON-RPC documentation transformation
 
+Symfony bundle for [yoanm/jsonrpc-params-symfony-constraint-doc-sdk](https://github.com/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk)
+
 ## How to use
 
+Once configured, your project will automatically create documentation for JSON-RPC params
+
+See below how to configure it.
+
+## Configuration
+
+[Behat demo app configuration folders](./features/demo_app) can be used as examples.
+
+ - 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],
+       Yoanm\SymfonyJsonRpcHttpServerDoc\JsonRpcHttpServerDocBundle::class => ['all' => true],
+       Yoanm\SymfonyJsonRpcParamsSfConstraintsDoc\JsonRpcParamsSfConstraintsDocBundle::class => ['all' => true],
+       ...
+   ];
+   ```
+   
+ - Configure `yoanm/symfony-jsonrpc-http-server` as described on [yoanm/symfony-jsonrpc-http-server](https://github.com/yoanm/symfony-jsonrpc-http-server) documentation.
+ 
+ - Configure `yoanm/symfony-jsonrpc-http-server-doc` as described on [yoanm/symfony-jsonrpc-http-server-doc](https://github.com/yoanm/symfony-jsonrpc-http-server-doc) documentation.
+ 
+ - Query your project at documentation endpoint and you should see JSON-RPC params documentation for each methods