www.aleph1.co.uk Git - yaffs-website/blob - vendor/symfony-cmf/routing/README.md

   1 # Symfony CMF Routing Component
   2
   3 [![Build Status](https://travis-ci.org/symfony-cmf/routing.svg?branch=master)](https://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)
   6
   7 The Symfony CMF Routing component extends the Symfony2 core routing component.
   8 It provides:
   9
  10  * A ChainRouter to run several routers in parallel
  11  * A DynamicRouter that can load routes from any database and can generate
  12    additional information in the route match.
  13
  14 Even though it has Symfony in its name, the Routing component does not need the
  15 full Symfony2 Framework and can be used in standalone projects.
  16
  17 For Symfony 2 projects, an optional
  18 [RoutingBundle](https://github.com/symfony-cmf/RoutingBundle)
  19 is also available.
  20
  21 This library is provided by the [Symfony Content Management Framework (CMF) project](http://cmf.symfony.com/)
  22 and licensed under the [MIT License](LICENSE).
  23
  24
  25 ## Requirements
  26
  27 * The Symfony Routing component (>= 2.2.0)
  28 * See also the `require` section of [composer.json](composer.json)
  29
  30
  31 ## Documentation
  32
  33 For the install guide and reference, see:
  34
  35 * [Routing component documentation](http://symfony.com/doc/master/cmf/components/routing/index.html)
  36
  37 See also:
  38
  39 * [All Symfony CMF documentation](http://symfony.com/doc/master/cmf/index.html) - complete Symfony CMF reference
  40 * [Symfony CMF Website](http://cmf.symfony.com/) - introduction, live demo, support and community links
  41
  42
  43 ## Contributing
  44
  45 Pull requests are welcome. Please see our
  46 [CONTRIBUTING](https://github.com/symfony-cmf/symfony-cmf/blob/master/CONTRIBUTING.md)
  47 guide.
  48
  49 Unit and/or functional tests exist for this component. See the
  50 [Testing documentation](http://symfony.com/doc/master/cmf/components/testing.html)
  51 for a guide to running the tests.
  52
  53 Thanks to
  54 [everyone who has contributed](https://github.com/symfony-cmf/Routing/contributors) already.