Skip to content
Browse files

Merge pull request #388 from havvg/master

update README for Packagist
  • Loading branch information...
2 parents 301c58a + 7589da1 commit abcef0ad90dd80eb628465be06acb69d9584cd71 @havvg havvg committed Jan 23, 2016
Showing with 54 additions and 50 deletions.
  1. +54 −50 README.markdown
View
104 README.markdown
@@ -1,50 +1,54 @@
-PropelBundle
-============
-
-[![Build Status](https://secure.travis-ci.org/propelorm/PropelBundle.png)](http://travis-ci.org/propelorm/PropelBundle)
-
-This is the official implementation of [Propel](http://www.propelorm.org/) in Symfony2.
-
-## Branching model
-
-As `Propel2` will be released in the near future, we are migrating the branching model of this bundle in advance!
-
-* The `1.0` branch will contain Propel *1.6* integration for Symfony *2.0* (*currently 2.0 branch*).
-* The `1.1` branch will contain Propel *1.6* integration for Symfony *2.1* (*currently master branch*).
-* The `2.0` branch will contain `Propel2` integration for Symfony *2.1*.
- We are still considering to integrate `Propel2` with Symfony *2.0*.
- In case, we will do so, there will be a `2.1` and `2.0` branch integrating the respective Symfony version!
-
-**The 1.x branches are already available and you are encouraged to migrate your dependencies according to the listings!**
-
-* If you depend on the `master` branch, switch to the `1.1` branch.
-* If you depend on the `2.0` branch, switch to the `1.0` branch.
-
-**Note:** the `master`, and `2.0` branches won't be updated anymore, and will trigger a `E_USER_DEPRECATED` error to notice people.
-
-## Features
-
- * Generation of model classes based on an XML schema (not YAML) placed under `BundleName/Resources/config/*schema.xml`.
- * Insertion of SQL statements.
- * Runtime autoloading of Propel and generated classes.
- * Propel runtime initialization through the XML configuration.
- * Migrations [Propel 1.6](http://www.propelorm.org/documentation/10-migrations.html).
- * Reverse engineering from [existing database](http://www.propelorm.org/cookbook/working-with-existing-databases.html).
- * Integration to the Symfony2 Profiler.
- * Load SQL, YAML and XML fixtures.
- * Create/Drop databases.
- * Integration with the Form component.
- * Integration with the Security component.
- * Propel ParamConverter can be used with Sensio Framework Extra Bundle.
- * Schema Inheritance.
- * Symfony2 ACL.
-
-For documentation, see:
-
- Resources/doc/
-
-[Read the documentation](https://github.com/propelorm/PropelBundle/blob/master/Resources/doc/README.markdown)
-
-For license, see:
-
- Resources/meta/LICENSE
+PropelBundle
+============
+
+[![Build Status](https://secure.travis-ci.org/propelorm/PropelBundle.png)](http://travis-ci.org/propelorm/PropelBundle)
+[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/propelorm/PropelBundle?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+This is the official implementation of [Propel](http://www.propelorm.org/) in Symfony2.
+
+## Branching model
+
+### Propel1 integration
+
+The two major branches being supported are:
+
+* The `1.5` branch contains Propel *1.6+* integration for Symfony *2.8 LTS*.
+* The `1.6` branch contains Propel *1.6+* integration for Symfony *3.0*.
+
+If you are running on an older version, you may require one of the following versions of this bundle.
+
+* The `1.0` branch contains Propel *1.6* integration for Symfony *2.0*.
+* The `1.1` branch contains Propel *1.6* integration for Symfony *2.1*.
+* The `1.2` branch contains Propel *1.6* integration for Symfony *>2.1*.
+* The `1.4` branch contains Propel *1.6* integration for Symfony *>2.3*.
+
+### Propel2 integration
+
+* The `2.0` branch will contain `Propel2` integration for Symfony *3.0*.
+
+**Note:** the `master` branch won't be updated anymore, and will trigger an `E_USER_DEPRECATED` error to notice people.
+
+## Features
+
+ * Generation of model classes based on an XML schema (not YAML) placed under `BundleName/Resources/*schema.xml`;
+ * Insertion of SQL statements;
+ * Runtime autoloading of Propel and generated classes;
+ * Propel runtime initialization through the XML configuration;
+ * Migrations [Propel 1.6](http://www.propelorm.org/documentation/10-migrations.html);
+ * Reverse engineering from [existing database](http://www.propelorm.org/wiki/Documentation/1.6/Existing-Database);
+ * Integration to the Symfony2 Profiler;
+ * Load SQL, YAML and XML fixtures;
+ * Create/Drop databases;
+ * Integration with the Form component;
+ * Integration with the Security component;
+ * Propel ParamConverter can be used with Sensio Framework Extra Bundle.
+
+For documentation, see:
+
+ Resources/doc/
+
+[Read the documentation](https://github.com/propelorm/PropelBundle/blob/1.5/Resources/doc/index.markdown)
+
+For license, see:
+
+ Resources/meta/LICENSE

0 comments on commit abcef0a

Please sign in to comment.
Something went wrong with that request. Please try again.