From c2157c3dca947f5964eb2a4e591e220b7b25ebb6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20J=C4=99drzejewski?= Date: Thu, 1 Nov 2012 23:01:37 +0100 Subject: [PATCH] Readme should be smaller and up-to-date --- src/Sylius/Bundle/CartBundle/README.md | 47 ++++++++++---------------- 1 file changed, 17 insertions(+), 30 deletions(-) diff --git a/src/Sylius/Bundle/CartBundle/README.md b/src/Sylius/Bundle/CartBundle/README.md index 3d63f9de69..dcc6279272 100644 --- a/src/Sylius/Bundle/CartBundle/README.md +++ b/src/Sylius/Bundle/CartBundle/README.md @@ -1,69 +1,56 @@ SyliusCartBundle [![Build status...](https://secure.travis-ci.org/Sylius/SyliusCartBundle.png)](http://travis-ci.org/Sylius/SyliusCartBundle) ================ -Flexible cart engine for Symfony2. Allows you to add any object to cart, customize the structure of it and much more. -Should be considered as base for building solution that fits your exact needs. +Flexible cart engine for Symfony2. Allows you to add any object to cart, customize the structure of item and much more. +Should be considered as a base for building solution that fits your exact needs. Sylius ------ -**Sylius** is simple but **end-user and developer friendly** webshop engine built on top of Symfony2. +**Sylius**, webshop engine for Symfony2. -Please visit [Sylius.org](http://sylius.org) for more details. +Visit [Sylius.org](http://sylius.org). -Testing and build status ------------------------- - -This bundle uses [travis-ci.org](http://travis-ci.org/Sylius/SyliusCartBundle). -[![Build status...](https://secure.travis-ci.org/Sylius/SyliusCartBundle.png)](http://travis-ci.org/Sylius/SyliusCartBundle) - -Before running tests, load the dependencies using [Composer](http://packagist.org). +[phpspec2](http://phpspec.net) Specifications +--------------------------------------------- ``` bash $ wget http://getcomposer.org/composer.phar $ php composer.phar install --dev +$ bin/phpspec run ``` -Now you can run the tests by simply using this command. +Documentation +------------- -``` bash -$ phpunit -``` +Documentation is available on [**readthedocs.org**](http://sylius.readthedocs.org/en/latest/bundles/SyliusCartBundle.html). Code examples ------------- If you want to see working implementation, try out the [Sylius sandbox application](http://github.com/Sylius/Sylius-Sandbox). -It's open sourced github project. -Documentation -------------- - -Documentation is available on [Sylius.org](http://sylius.org/docs/bundles/SyliusCartBundle.html). Contributing ------------ -All informations about contributing to Sylius can be found on [this page](http://sylius.org/docs/contributing/index.html). +All informations about contributing to Sylius can be found on [this page](http://sylius.readthedocs.org/en/latest/contributing/index.html). Mailing lists ------------- ### Users -If you are using this bundle and have any questions, feel free to ask on users mailing list. -[Mail](mailto:sylius@googlegroups.com) or [view it](http://groups.google.com/group/sylius). +Questions? Feel free to ask on [users mailing list](http://groups.google.com/group/sylius). ### Developers -If you want to contribute, and develop this bundle, use the developers mailing list. -[Mail](mailto:sylius-dev@googlegroups.com) or [view it](http://groups.google.com/group/sylius-dev). +To contribute and develop this bundle, use the [developers mailing list](http://groups.google.com/group/sylius-dev). Sylius twitter account ---------------------- -If you want to keep up with updates, [follow the official Sylius account on twitter](http://twitter.com/_Sylius) -or [follow me](http://twitter.com/pjedrzejewski). +If you want to keep up with updates, [follow the official Sylius account on twitter](http://twitter.com/_Sylius). Bug tracking ------------ @@ -82,11 +69,11 @@ And constructed with the following guidelines. * New additions without breaking backwards compatibility bumps the minor. * Bug fixes and misc changes bump the patch. -For more information on SemVer, please visit [semver.org website](http://semver.org/). +For more information on SemVer, please visit [semver.org website](http://semver.org/)... This versioning method is same for all **Sylius** bundles and applications. -License -------- +MIT License +----------- License can be found [here](https://github.com/Sylius/SyliusCartBundle/blob/master/Resources/meta/LICENSE).