Merge pull request #116 from phansys/dependencies

Update documentation

Author: hackzilla

README.md

@@ -1,7 +1,14 @@
 # Ticketing Bundle v3
 
-Simple multilingual ticketing bundle to add to any project.
-Languages: English, French, Russian, German and Spanish.
+Simple ticketing bundle for any project.
+Available translations for:
+ * English
+ * French
+ * German
+ * Italian
+ * Portuguese
+ * Russian
+ * Spanish
 
 [![Build Status](https://travis-ci.org/hackzilla/TicketBundle.png?branch=master)](https://travis-ci.org/hackzilla/TicketBundle)
 [![SensioLabsInsight](https://insight.sensiolabs.com/projects/091d37a9-7862-4365-952c-814ce95c4d6c/mini.png)](https://insight.sensiolabs.com/projects/091d37a9-7862-4365-952c-814ce95c4d6c)
@@ -10,35 +17,34 @@ Languages: English, French, Russian, German and Spanish.
 ## Requirements
 
 * PHP >= 5.6
-* Symfony ~2.8|~3.0
-* Knp Paginator
-* Bootstrap v3 (optional) see: http://symfony.com/blog/new-in-symfony-2-6-bootstrap-form-theme
+* [Symfony][1] ^2.8|^3.0|^4.0
+* [Knp Paginator bundle][2]
+* [Bootstrap v3][3] (optional) see: [http://symfony.com/blog/new-in-symfony-2-6-bootstrap-form-theme][4]
 
 ## Optional Requirements
 
-* FOSUserBundle
+* [FOSUserBundle][5]
 
 
 ## Version Matrix
 
-| Ticket Bundle                                                          | Symfony    | PHP   |
-| ---------------------------------------------------------------------- | ---------- | ----- |
-| [3.x](https://github.com/hackzilla/TicketBundle/tree/master) (master)  | ^2.8\|^3.0 | >=5.6 |
-| [2.x](https://github.com/hackzilla/TicketBundle/tree/2.x)              | ^2.7\|^3.0 | >=5.3 |
-| [1.x](https://github.com/hackzilla/TicketBundle/tree/1.x)              | ^2.3       | >=5.3 |
-| [0.x](https://github.com/hackzilla/TicketBundle/tree/0.9.x)            | ^2.3       | >=5.3 |
+| Ticket Bundle     | Symfony         | PHP   |
+| ------------------| --------------- | ----- |
+| [3.x][6] (master) | ^2.8\|^.0\|^4.0 | >=5.6 |
+| [2.x][7]          | ^2.7\|^3.0      | >=5.3 |
+| [1.x][8]          | ^2.3            | >=5.3 |
+| [0.x][9]          | ^2.3            | >=5.3 |
 
 
 ## Demo
 
-See [Ticket Bundle Demo App](https://github.com/hackzilla/TicketBundleDemoApp) for an example installation.  This can also be used for confirming bugs.
+See [Ticket Bundle Demo App][10] for an example installation. This can also be used for confirming bugs.
 
 
 ## Setup
 
-* [Installation with FOSUserBundle](Resources/doc/setup/fosuserbundle.md)
-* [Generic Installation](Resources/doc/setup/other.md)
-
+* [Installation with FOSUserBundle][11]
+* [Generic Installation][12]
 
 
 ## Optional Features
@@ -47,22 +53,22 @@ These optional features that can be turned on or off.
 
 ### Features
 
-* [Attachments](Resources/doc/setup/feature/attachments.md)
-* [Custom Entities](Resources/doc/setup/feature/custom-entities.md)
-* [Events](Resources/doc/setup/feature/events.md)
+* [Attachments][13]
+* [Custom Entities][14]
+* [Events][15]
 
 # 3rd Party Extensions
 
-# [Email Notification](https://github.com/flodaq/TicketNotificationBundle)
+# [Email Notification][16]
 
 
 ## Custom Templates (Optional)
 
-```
-config.yml
+```yaml
+# config.yml
 
 hackzilla_ticket:
-    templates: 
+    templates:
         index: 'YOURTicketBundle:Ticket:index.html.twig'
         new: 'YOURTicketBundle:Ticket:new.html.twig'
         prototype: 'YOURTicketBundle:Ticket:prototype.html.twig'
@@ -72,9 +78,27 @@ hackzilla_ticket:
 
 ## Migrate a Previous Version
 
-* [Information moved](Resources/doc/migrate/index.md)
+* [How to migrate][17]
 
 
 ## Pull Requests
 
 I'm open to pull requests for additional languages, features and/or improvements.
+
+[1]: https://symfony.com/
+[2]: https://github.com/KnpLabs/KnpPaginatorBundle
+[3]: http://getbootstrap.com/docs/3.3/
+[4]: http://symfony.com/blog/new-in-symfony-2-6-bootstrap-form-theme
+[5]: https://symfony.com/doc/current/bundles/FOSUserBundle/index.html
+[6]: https://github.com/hackzilla/TicketBundle/tree/master
+[7]: https://github.com/hackzilla/TicketBundle/tree/2.x
+[8]: https://github.com/hackzilla/TicketBundle/tree/1.x
+[9]: https://github.com/hackzilla/TicketBundle/tree/0.9.x
+[10]: https://github.com/hackzilla/TicketBundleDemoApp
+[11]: Resources/doc/setup/fosuserbundle.md
+[12]: Resources/doc/setup/other.md
+[13]: Resources/doc/setup/feature/attachments.md
+[14]: Resources/doc/setup/feature/custom-entities.md
+[15]: Resources/doc/setup/feature/events.md
+[16]: https://github.com/flodaq/TicketNotificationBundle
+[17]: Resources/doc/migrate/index.md

Resources/doc/migrate/v1-to-v2.md

@@ -4,7 +4,7 @@ Add your user class into your config.
 
 ```yaml
 hackzilla_ticket:
-    user_class:             AppBundle\Entity\User
+    user_class: AppBundle\Entity\User
 ```
 
 ```Hackzilla\Bundle\TicketBundle\User\UserInterface``` has been replaced with ```Hackzilla\Bundle\TicketBundle\Manager\UserManagerInterface```

Resources/doc/migrate/v2-to-v3.md

@@ -1,6 +1,6 @@
 ## Migration from v2 to v3
 
-Any reference to TicketMessage constants will need to use TicketMessageInterface.
+Any reference to `TicketMessage` constants will need to use `TicketMessageInterface`.
 
 Previously:
 
@@ -16,12 +16,12 @@ Hackzilla\Bundle\TicketBundle\Model\TicketMessageInterface::STATUS_OPEN
 Hackzilla\Bundle\TicketBundle\Model\TicketMessageInterface::STATUS_CLOSED
 ```
 
-### TicketManagerInterface Changes
+### `TicketManagerInterface` Changes
 
 The interface ```Hackzilla\Bundle\TicketBundle\Manager\TicketManagerInterface``` has been modified.
 
-* Entity Manager needs passing in through setEntityManager()
-* Translator needs passing in through setTranslator()
-* getTicketStatus and getTicketPriority no longer need translator passing
-* added createMessage() and getMessageById()
-* updateTicket() now can take an optional message object.
+* Entity Manager needs passing in through `setEntityManager()`
+* Translator needs passing in through `setTranslator()`
+* `getTicketStatus()` and `getTicketPriority()` no longer need translator passing
+* added `createMessage()` and `getMessageById()`
+* `updateTicket()` now can take an optional message object.

Resources/doc/setup/fosuserbundle.md

@@ -2,22 +2,18 @@
 
 ## Step 1: Installation
 
-Add HackzillaTicketBundle in your composer.json:
+Add HackzillaTicketBundle to your requirements:
 
-```json
-{
-    "require": {
-        "hackzilla/ticket-bundle": "~2.0@dev",
-        "friendsofsymfony/user-bundle": "~2.0@dev",
-    }
-}
+```bash
+composer require hackzilla/ticket-bundle:^2.0@dev
+composer require friendsofsymfony/user-bundle:^2.0
 ```
 
-Specify your user class in your config, this will be exactly the same as user_class in FOSUserBundle.
+Specify your user class in your config, this will be exactly the same as `user_class` in FOSUserBundle.
 
 ```yaml
 hackzilla_ticket:
-    user_class:             AppBundle\Entity\User
+    user_class: AppBundle\Entity\User
 ```
 
 Your user class needs to implement ```Hackzilla\Bundle\TicketBundle\Model\UserInterface```
@@ -36,29 +32,29 @@ class User extends BaseUser implements \Hackzilla\Bundle\TicketBundle\Model\User
 }
 ```
 
-Follow [FOSUserBundle guide](https://github.com/FriendsOfSymfony/FOSUserBundle)
-
+Follow [FOSUserBundle guide][1]
 
-Install Composer
-
-```
-curl -sS https://getcomposer.org/installer | php
-mv composer.phar /usr/local/bin/composer
-```
+## Step 2: Enable the bundle
 
-Now tell composer to download the library by running the command:
+Enable the bundle in the kernel:
 
-``` bash
-$ composer update hackzilla/ticket-bundle
+```php
+<?php
+// config/bundles.php
+
+return [
+    FOS\UserBundle\FOSUserBundle::class => ['all' => true],
+    Knp\Bundle\PaginatorBundle\KnpPaginatorBundle::class => ['all' => true],
+    Sensio\Bundle\FrameworkExtraBundle\SensioFrameworkExtraBundle::class => ['all' => true],
+    Hackzilla\Bundle\TicketBundle\HackzillaTicketBundle::class => ['all' => true],
+    // ...
+    // Your application bundles
+];
 ```
 
-Composer will install the bundle into your project's `vendor/hackzilla` directory.
-
-## Step 2: Enable the bundle
-
-Enable the bundle in the kernel:
+Or if you are not using Flex:
 
-``` php
+```php
 <?php
 // app/AppKernel.php
 
@@ -78,25 +74,27 @@ public function registerBundles()
 
 ## Step 3: Import the routing
 
-``` yml
+```yaml
 hackzilla_ticket:
     resource: "@HackzillaTicketBundle/Resources/config/routing.yml"
-    prefix:   /
+    prefix: /
 ```
 
 or
 
-``` yml
+```yaml
 hackzilla_ticket:
     resource: "@HackzillaTicketBundle/Resources/config/routing/ticket.yml"
-    prefix:   /ticket
+    prefix: /ticket
 ```
 
 ## Step 4: Roles
 
 All users can create tickets, even anonymous users.
-You can assign ROLE_TICKET_ADMIN to any user you want to be able to administer the ticketing system.
+You can assign "ROLE_TICKET_ADMIN" to any user you want to be able to administer the ticketing system.
 
 ## Step 5: Create tables
 
 ```bin/console doctrine:schema:update --force```
+
+[1]: https://github.com/FriendsOfSymfony/FOSUserBundle