Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
69 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,30 @@ | ||
# GundanDistributedConfigurationBundle | ||
|
||
The main idea of this bundle is to have a centralized configuration app. So you can register any configuration from different app. | ||
|
||
## Features | ||
|
||
- REST API | ||
- Based on [key-value-store](https://github.com/webmozart/key-value-store) | ||
- Multiple persistent store (Redis, Predis, Dbal, JsonFile, **more to come**) | ||
|
||
[![Build Status](https://img.shields.io/travis/eljam/GundanDistributedConfigurationBundle.svg?branch=master&style=flat-square)](https://travis-ci.org/eljam/GundanDistributedConfigurationBundle.svg) | ||
[![Code Quality](https://img.shields.io/scrutinizer/g/eljam/GundanDistributedConfigurationBundle.svg?b=master&style=flat-square)](https://scrutinizer-ci.com/g/eljam/GundanDistributedConfigurationBundle/?branch=master) | ||
[![Code Coverage](https://img.shields.io/coveralls/eljam/GundanDistributedConfigurationBundle.svg?style=flat-square)](https://coveralls.io/r/eljam/GundanDistributedConfigurationBundle) | ||
[![Latest Unstable Version](https://poser.pugx.org/gundan/distributed-configuration-bundle/v/unstable)](https://packagist.org/packages/gundan/distributed-configuration-bundle) | ||
[![Latest Stable Version](https://poser.pugx.org/gundan/distributed-configuration-bundle/v/stable)](https://packagist.org/packages/eljam/distributed-configuration-bundle) | ||
[![Downloads](https://img.shields.io/packagist/dt/gundan/distributed-configuration-bundle.svg)](https://packagist.org/packages/eljam/distributed-configuration-bundle) | ||
[![license](https://img.shields.io/packagist/l/gundan/distributed-configuration-bundle.svg)](https://github.com/gundan/distributed-configuration-bundle/blob/master/LICENSE) | ||
|
||
## Documentation | ||
|
||
For documentation, see: | ||
|
||
Resources/doc/ | ||
|
||
[Read the documentation](https://github.com/eljam/GundanDistributedConfigurationBundle/blob/master/Resources/doc/index.md) | ||
|
||
License | ||
------- | ||
|
||
This bundle is released under the MIT license. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# GundanDistributedConfigurationBundle | ||
|
||
|
||
This bundle provides extra features for your REST APIs built using Symfony2. | ||
|
||
# Installation | ||
|
||
```bash | ||
$ composer.phar require willdurand/rest-extra-bundle | ||
``` | ||
|
||
Register the bundle in `app/AppKernel.php`: | ||
|
||
``` php | ||
// app/AppKernel.php | ||
public function registerBundles() | ||
{ | ||
return array( | ||
// ... | ||
new \Symfony\Bundle\FrameworkBundle\FrameworkBundle(), | ||
new \JMS\SerializerBundle\JMSSerializerBundle($this), | ||
new \FOS\RestBundle\FOSRestBundle() | ||
new \Gundan\DistributedConfigurationBundle\GundanDistributedConfigurationBundle(), | ||
); | ||
} | ||
``` | ||
|
||
Enable the bundle's configuration in `app/config/config.yml`: | ||
|
||
``` yaml | ||
# app/config/config.yml | ||
gundan_distributed_configuration: | ||
store: | ||
json: | ||
path: "%kernel.root_dir%/test.json" | ||
``` | ||
|
||
## Usage | ||
|
||
TODO |