Skip to content

Commit

Permalink
Add doc
Browse files Browse the repository at this point in the history
  • Loading branch information
eljam committed Jun 14, 2016
1 parent 0af9071 commit 6124bb8
Show file tree
Hide file tree
Showing 2 changed files with 69 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
@@ -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.
40 changes: 40 additions & 0 deletions Resources/doc/index.md
@@ -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

0 comments on commit 6124bb8

Please sign in to comment.