Skip to content

Commit 3810e40

Browse files
committed
update docs
1 parent 5b389c5 commit 3810e40

3 files changed

Lines changed: 12 additions & 20 deletions

File tree

README.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
CCDNMessage MessageBundle README.
2-
=============================
2+
=================================
33

44
[![SensioLabsInsight](https://insight.sensiolabs.com/projects/1cc3942c-57b7-4c6f-8e8b-f74bc4ebb234/mini.png)](https://insight.sensiolabs.com/projects/1cc3942c-57b7-4c6f-8e8b-f74bc4ebb234) [![Build Status](https://secure.travis-ci.org/codeconsortium/CCDNMessageMessageBundle.png)](https://travis-ci.org/codeconsortium/CCDNMessageMessageBundle) [![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/codeconsortium/CCDNMessageMessageBundle/badges/quality-score.png?s=5fe7a2cc2e7dbee7a4e9eb7ddae6944553d400b3)](https://scrutinizer-ci.com/g/codeconsortium/CCDNMessageMessageBundle/) [![Code Coverage](https://scrutinizer-ci.com/g/codeconsortium/CCDNMessageMessageBundle/badges/coverage.png?s=23ddc79daf881c195bca0f0d23bcc183148d1a7f)](https://scrutinizer-ci.com/g/codeconsortium/CCDNMessageMessageBundle/) [![Latest Stable Version](https://poser.pugx.org/codeconsortium/ccdn-message-bundle/v/stable.png)](https://packagist.org/packages/codeconsortium/ccdn-message-bundle) [![Total Downloads](https://poser.pugx.org/codeconsortium/ccdn-message-bundle/downloads.png)](https://packagist.org/packages/codeconsortium/ccdn-message-bundle) [![Stories in Ready](https://badge.waffle.io/codeconsortium/ccdnmessagemessagebundle.png?label=ready)](https://waffle.io/codeconsortium/ccdnmessagemessagebundle)
55

66
## Notes:
77

8-
This bundle is for the symfony framework and requires Symfony >= 2.1.x and PHP >= 5.3.2
8+
This bundle is for the symfony framework and requires Symfony ~2.4 and PHP >= 5.3.2
99

1010
This project uses Doctrine >= 2.1.x and so does not require any specific database.
11-
1211

1312
© CCDN © [CodeConsortium](http://www.codeconsortium.com/)
1413

@@ -28,11 +27,7 @@ For the full copyright and license information, please view the [LICENSE](http:/
2827

2928
## Description:
3029

31-
This is a MessageBundle for Symfony (>= 2.1.x) for sending and receiving private message.
32-
33-
## Description:
34-
35-
This is a private messaging system as a bundle for Symfony (2.0.11).
30+
This is a private messaging system as a bundle for use in a Symfony2 project for sending and receiving private message.
3631

3732
Send and receive private messages as part of a symfony2 powered website.
3833

@@ -68,8 +63,6 @@ All the installation instructions are located in [documentation](http://github.c
6863
> Do NOT use the CLI doctrine/symfony console utility to force an update, data will be lost if you do!
6964
> Manually run the sql update in the upgrading docs. Always backup your database before updating.
7065
71-
To upgrade to version 1.1.2 please read the [upgrading to version 1.1.3 guide](http://github.com/codeconsortium/CCDNMessageMessageBundle/blob/v1.1.3/Resources/doc/upgrading_to_1_1_3.md).
72-
7366
## License.
7467

7568
This software is licensed under the MIT license. See the complete license file in the bundle:

Resources/doc/index.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
CCDNMessage MessageBundle Documentation.
22
========================================
33

4-
## Prerequisites
5-
6-
This version of the bundle requires Symfony 2.0.11.
7-
84
### Translations
95

106
If you wish to use default texts provided in this bundle, you have to make sure you have translator enabled in your config.
@@ -20,5 +16,5 @@ For more information about translations, check [Symfony documentation](http://sy
2016
2117
## Installation Documentation:
2218
23-
- [Installing CCDNMessage MessageBundle for Symfony 2.0.11](install.md).
19+
- [Installing CCDNMessage MessageBundle for Symfony](install.md).
2420
- [Configuration Reference](configuration_reference.md).

Resources/doc/install.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Installing CCDNMessage MessageBundle 2.x
2-
========================================
1+
Installing CCDNMessage MessageBundle
2+
====================================
33

44
## Dependencies:
55

@@ -50,12 +50,15 @@ register the new bundle:
5050
public function registerBundles()
5151
{
5252
$bundles = array(
53-
new CCDNMessage\MessageBundle\CCDNMessageMessageBundle(),
54-
...
55-
);
53+
new Knp\Bundle\PaginatorBundle\KnpPaginatorBundle(),
54+
new CCDNMessage\MessageBundle\CCDNMessageMessageBundle(),
55+
// ...
56+
);
5657
}
5758
```
5859

60+
Notice this include KNP Paginator, which is an important dependency.
61+
5962
### Step 3: Update your app/config/routing.yml.
6063

6164
In your app/config/routing.yml add:

0 commit comments

Comments
 (0)