Skip to content

Commit bce97d9

Browse files
author
Lars Janssen
committed
Updated README to new standard format
1 parent 8ffcc7f commit bce97d9

File tree

1 file changed

+46
-5
lines changed

1 file changed

+46
-5
lines changed

README.md

Lines changed: 46 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,48 @@
1-
# Symfony CMF Routing Component [![Build Status](https://secure.travis-ci.org/symfony-cmf/Routing.png)](http://travis-ci.org/symfony-cmf/Routing)
1+
# Symfony CMF Routing Component
22

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

7-
http://symfony.com/doc/master/cmf/components/routing.html
7+
The Symfony CMF Routing component extends the Symfony2 core routing component.
8+
Even though it has Symfony in its name, it does not need the full Symfony2
9+
Framework and can be used in standalone projects.
10+
11+
For Symfon2 projects, an optional
12+
[RoutingBundle](https://github.com/symfony-cmf/RoutingBundle)
13+
is also available.
14+
15+
This library is provided by the [Symfony Content Management Framework (CMF) project](http://cmf.symfony.com/)
16+
and licensed under the [MIT License](LICENSE).
17+
18+
19+
## Requirements
20+
21+
* The Symfony 2.2.x Routing component
22+
* See also the `require` section of [composer.json](composer.json)
23+
24+
25+
## Documentation
26+
27+
For the install guide and reference, see:
28+
29+
* [Routing component documentation](http://symfony.com/doc/master/cmf/components/routing.html)
30+
31+
See also:
32+
33+
* [All Symfony CMF documentation](http://symfony.com/doc/master/cmf/index.html)- complete Symfony CMF reference
34+
* [Symfony CMF Website](http://cmf.symfony.com/) - introduction, live demo, support and community links
35+
36+
37+
## Contributing
38+
39+
Pull requests are welcome. Please see our
40+
[CONTRIBUTING](https://github.com/symfony-cmf/symfony-cmf/blob/master/CONTRIBUTING.md)
41+
guide.
42+
43+
Unit and/or functional tests exist for this bundle. See the
44+
[Testing documentation](http://symfony.com/doc/master/cmf/components/testing.html)
45+
for a guide to running the tests.
46+
47+
Thanks to
48+
[everyone who has contributed](https://github.com/symfony-cmf/Routing/contributors) already.

0 commit comments

Comments
 (0)