Skip to content

Commit

Permalink
Merge pull request #79 from symfony-cmf/readme-update
Browse files Browse the repository at this point in the history
Updated README to new standard format
  • Loading branch information
dbu committed Aug 5, 2013
2 parents b23765f + c5d0562 commit dd47bba
Showing 1 changed file with 52 additions and 5 deletions.
57 changes: 52 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,54 @@
# Symfony CMF Routing Component [![Build Status](https://secure.travis-ci.org/symfony-cmf/Routing.png)](http://travis-ci.org/symfony-cmf/Routing)
# Symfony CMF Routing Component

This library extends the Symfony2 Routing component. Even though it has Symfony
in its name, it does not need the full Symfony2 framework and can be used in
standalone projects.
[![Build Status](https://secure.travis-ci.org/symfony-cmf/Routing.png)](http://travis-ci.org/symfony-cmf/Routing)
[![Latest Stable Version](https://poser.pugx.org/symfony-cmf/routing/version.png)](https://packagist.org/packages/symfony-cmf/routing)
[![Total Downloads](https://poser.pugx.org/symfony-cmf/routing/d/total.png)](https://packagist.org/packages/symfony-cmf/routing)

http://symfony.com/doc/master/cmf/components/routing.html
The Symfony CMF Routing component extends the Symfony2 core routing component.
It provides:

* A ChainRouter to run several routers in parallel
* A DynamicRouter that can load routes from any database and can generate
additional information in the route match.

Even though it has Symfony in its name, the Routing component does not need the
full Symfony2 Framework and can be used in standalone projects.

For Symfon2 projects, an optional
[RoutingBundle](https://github.com/symfony-cmf/RoutingBundle)
is also available.

This library is provided by the [Symfony Content Management Framework (CMF) project](http://cmf.symfony.com/)
and licensed under the [MIT License](LICENSE).


## Requirements

* The Symfony Routing component (>= 2.2.0)
* See also the `require` section of [composer.json](composer.json)


## Documentation

For the install guide and reference, see:

* [Routing component documentation](http://symfony.com/doc/master/cmf/components/routing.html)

See also:

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


## Contributing

Pull requests are welcome. Please see our
[CONTRIBUTING](https://github.com/symfony-cmf/symfony-cmf/blob/master/CONTRIBUTING.md)
guide.

Unit and/or functional tests exist for this component. See the
[Testing documentation](http://symfony.com/doc/master/cmf/components/testing.html)
for a guide to running the tests.

Thanks to
[everyone who has contributed](https://github.com/symfony-cmf/Routing/contributors) already.

0 comments on commit dd47bba

Please sign in to comment.