updated readme.

This commit is contained in:
Paweł Jędrzejewski 2011-11-02 18:41:05 +01:00
parent 552f3b15d5
commit 3b86f5e582

View file

@ -6,7 +6,13 @@ Sales management, orders and this kind of stuff.
Sylius.
-------
**Sylius** is a Symfony2 powered e-commerce system. Visit [sylius.org](http://sylius.org).
**Sylius** is simple but **end-user and developer friendly** webshop engine built on top of Symfony2. Visit [sylius.org](http://sylius.org).
Examples.
---------
If you want to see this and other bundles in action, try out the [Sylius sandbox application](http://github.com/Sylius/Sylius-Sandbox).
It's open sourced github project.
Documentation.
--------------
@ -18,14 +24,48 @@ Dependencies.
This bundle uses the awesome [Pagerfanta library](https://github.com/whiteoctober/Pagerfanta) and [Pagerfanta bundle](https://github.com/whiteoctober/WhiteOctoberPagerfantaBundle).
Mailing lists.
--------------
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).
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).
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).
Bug tracking.
-------------
This bundle uses [GitHub issues](https://github.com/Sylius/SyliusSalesBundle/issues).
If you have found bug, please create an issue.
Versioning.
-----------
Releases will be numbered with the format `<major>.<minor>.<patch>`.
And constructed with the following guidelines.
* Breaking backwards compatibility bumps the major.
* 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/).
This versioning method is same for all **Sylius** bundles and applications.
License.
--------
Licence can be found here...
Resources/meta/LICENSE
License can be found [here](https://github.com/Sylius/SyliusSalesBundle/blob/master/Resources/meta/LICENSE).
Authors.
--------
The bundle was originally created by [Paweł Jędrzejewski](http://diweb.pl).
See the list of [contributors](https://github.com/Sylius/SyliusSalesBundle/contributors).