Optimize readme file

[mickeyambrosius]

I found your nice UnifikDatabaseConfigBundle when searching for some database enabled configuration for Symfony. Been trying to set it up and finally succeeded, but I think something might be missing in the readme file. In order to have the configurator forms working I required the following setup in MyBundle\DependencyInjection\Controller.php.

(I found from debugging the code and afterwards found the text about it in ConfiguratorType, doh!)

class Configuration implements ConfigurationInterface
{
public function getConfigTreeBuilder()
{
$treeBuilder = new TreeBuilder();

    $rootNode = $treeBuilder->root('bundle_alias');
    $rootNode
        ->children()
            ->arrayNode('globals')->attribute('configurator', true)
            ->children()
                ->arrayNode('shopify')->attribute('configurator', true)
                    ->children()
                        ->scalarNode('api_key')->attribute('configurator', true)->end()
                        ->scalarNode('api_secret')->attribute('configurator', true)->end()
                        ->scalarNode('api_scope')->attribute('configurator', true)->end()
                        ->scalarNode('api_token')->attribute('configurator', true)->end()
                        ->scalarNode('shop_name')->attribute('configurator', true)->end()
                    ->end()
                ->end()
            ->end()
        ->end()
    ;

    return $treeBuilder;
}

}

I think it would be a big help to point out in the readme how the getConfigTreeBuilder should be structured and the nodes decorated with 'configurator' attribute. Also it might make sense to point out that the ConfigurationTree needs to be modeled before the Bundle works. Last thing, I think it would help to specify the that it's the bundle alias being used in the container_extension table and maybe give an example (it might be common knowledge for a Symfony developer, but wouldn't hurt :)

Do let me know if I should contribute to the readme.

Thanks

[guillaume-petit]

I agree with you. I stumbled across the exact same problem and only found out by crawling in the code.

[hubertperron]

The configurator form is still an experimental feature of the bundle and this is why it's not featured in the readme file.

But as this feature seems quite popular, i'll look into improving the documentation. Feel free to submit a PR to improve the documentation if you like.