Skip to content

Commit 0cb8931

Browse files
committed
Merge pull request #129 from symfony-cmf/readme-cleanup
Updated README to new, standard format.
2 parents 3877a2a + 7c18775 commit 0cb8931

File tree

1 file changed

+33
-30
lines changed

1 file changed

+33
-30
lines changed

README.md

Lines changed: 33 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,45 @@
1-
# Symfony CMF Routing Bundle [![Build Status](https://secure.travis-ci.org/symfony-cmf/RoutingBundle.png)](http://travis-ci.org/symfony-cmf/RoutingBundle)
1+
# Symfony CMF Routing Bundle
22

3-
This bundle enables the [CMF Routing component](https://github.com/symfony-cmf/Routing)
4-
as Symfony2 bundle. It provides route documents for Doctrine PHPCR-ODM and a
3+
[![Build Status](https://secure.travis-ci.org/symfony-cmf/RoutingBundle.png)](http://travis-ci.org/symfony-cmf/RoutingBundle)
4+
[![Latest Stable Version](https://poser.pugx.org/symfony-cmf/routing-bundle/version.png)](https://packagist.org/packages/symfony-cmf/routing-bundle)
5+
[![Total Downloads](https://poser.pugx.org/symfony-cmf/routing-bundle/d/total.png)](https://packagist.org/packages/symfony-cmf/routing-bundle)
6+
7+
This bundle is part of the [Symfony Content Management Framework (CMF)](http://cmf.symfony.com/)
8+
and licensed under the [MIT License](LICENSE).
9+
10+
The RoutingBundle enables the
11+
[CMF Routing component](https://github.com/symfony-cmf/Routing)
12+
as a Symfony2 bundle. It provides route documents for Doctrine PHPCR-ODM and a
513
controller for redirection routes.
614

7-
The *chain router* is meant to replace the default Symfonys Router. All it does
8-
is collect a prioritized list of routers and try to match requests and generate
9-
urls with all of them. One of the routers in that chain can of course be the
10-
default router so you can still use the standard way for some of your routes.
1115

12-
Additionally, this bundle delivers useful router implementations. Currently,
13-
there is the *DynamicRouter* that routes based on a implemented repository that
14-
provide Symfony2 Route objects. The repository can be implemented using a
15-
database, for example with Doctrine PHPCR-ODM or Doctrine ORM. The bundle
16-
provides a default implementation for Doctrine PHPCR-ODM.
16+
## Requirements
17+
18+
* Symfony 2.2.x
19+
* See also the `require` section of [composer.json](composer.json)
20+
21+
22+
## Documentation
23+
24+
For the install guide and reference, see:
1725

18-
The DynamicRouter service is only made available when explicitly enabled in the
19-
application configuration.
26+
* [RoutingBundle documentation](http://symfony.com/doc/master/cmf/bundles/routing.html)
2027

21-
See the [official documentation](http://symfony.com/doc/master/cmf/bundles/routing.html)
28+
See also:
2229

23-
## Installation
30+
* [All Symfony CMF documentation](http://symfony.com/doc/master/cmf/index.html)- complete Symfony CMF reference
31+
* [Symfony CMF Website](http://cmf.symfony.com/) - introduction, live demo, support and community links
2432

25-
Add a requirement for ```symfony-cmf/routing-bundle``` to your
26-
composer.json and instantiate the bundle in your AppKernel.php
2733

28-
new Symfony\Cmf\Bundle\RoutingBundle\CmfRoutingBundle()
34+
## Contributing
2935

30-
If you just want to use the chain router, this is enough.
31-
For the DynamicRouter you need something to build a repository.
32-
This bundle provides classes for Doctrine PHPCR ODM.
36+
Pull requests are welcome. Please see our
37+
[CONTRIBUTING](https://github.com/symfony-cmf/symfony-cmf/blob/master/CONTRIBUTING.md)
38+
guide.
3339

34-
## Authors
40+
Unit and/or functional tests exist for this bundle. See the
41+
[Testing documentation](http://symfony.com/doc/master/cmf/components/testing.html)
42+
for a guide to running the tests.
3543

36-
* Filippo De Santis (p16)
37-
* Henrik Bjornskov (henrikbjorn)
38-
* Claudio Beatrice (omissis)
39-
* Lukas Kahwe Smith (lsmith77)
40-
* David Buchmann (dbu)
41-
* Uwe Jäger (uwej711)
42-
* [And others](https://github.com/symfony-cmf/RoutingBundle/contributors)
44+
Thanks to
45+
[everyone who has contributed](https://github.com/symfony-cmf/RoutingBundle/contributors) already.

0 commit comments

Comments
 (0)