updated docs

README.markdown

@@ -1,28 +1,19 @@
-fgePortfolioBundle
+StfalconPortfolioBundle
 =============
 
-The PortfolioBundle adds some basic support for your protfolio. You can create categories and projects
-This bundle requires configured sonata/admin-bundle with ORM support for administration, VichUploaderBundle
-for images in projects, and StofDoctrineExtensionsBundle for timestamps
-
-Features include:
-
-- Projects and categories can be stored via Doctrine ORM
-- Pagination of projects and categories
-- Administrating via SonataAdminBundle
-- Syntax highlighting with geshi.
-  Wrap code blocks with  ```<pre lang="LANGUAGE" line="1">``` and ```</pre>``` where "LANGUAGE" is a Geshi supported language syntax.
-- Cut is available with <!--more--> tag
-- Unit tested
+The StfalconPortfolioBundle adds some basic support for your portfolio. You can create categories and projects
+This bundle requires configured SonataAdminBundle with ORM support for administration, VichUploaderBundle
+for images in projects, and StofDoctrineExtensionsBundle for timestamps.
 
+Studio stfalcon.com use this bundle for portfolio http://stfalcon.com/portfolio/web-development
 
-Documentation
--------------
-
-The bulk of the documentation is stored in the `Resources/doc/index.md`
-file in this bundle:
-
-[Read the Documentation for master](https://github.com/stfalcon/PortfolioBundle/blob/master/Resources/doc/index.md)
+Features include:
+- Projects and categories can be stored (with Doctrine ORM)
+- Administrating with SonataAdminBundle
+- Pagination of projects (with KnpPaginatorBundle)
+- Breadcrumbs (with KnpMenuBundle)
+- Upload images (with VichUploaderBundle) and resize it to thumbnails (with AvalancheImagineBundle)
+- PHPUnit tests
 
 Installation
 ------------
@@ -49,4 +40,4 @@ Issues and feature requests are tracked in the [Github issue tracker](https://gi
 When reporting a bug, it may be a good idea to reproduce it in a basic project
 built using the [Symfony Standard Edition](https://github.com/symfony/symfony-standard)
 to allow developers of the bundle to reproduce the issue by simply cloning it
-and following some steps.
+and following some steps.

Resources/doc/index.md

@@ -1,44 +1,48 @@
-Getting Started With PortfolioBundle
+Getting Started With StfalconPortfolioBundle
 ==================================
 
-Simple small bundle for simple site portfolio
+Simple bundle for site portfolio
 
 ## Prerequisites
 
 This version of the bundle requires:
 
 1. Symfony >= 2.1
-2. LiipFunctionalTestBundle for testing
-3. DoctrineFixturesBundle for fixtures
+2. LiipFunctionalTestBundle for testing (optional)
+3. DoctrineFixturesBundle for fixtures (optional)
 4. SonataAdminBundle for administering
 5. VichUploaderBundle for uploads
 6. StofDoctrineExtensionsBundle for timestamps
 7. KnpPaginatorBundle for automate pagination
 
-## Bundle features
-
-
-
 ## Installation
 
 Installation is a quick 4 step process:
 
-1. Add PortfolioBundle in your composer.json
-2. Enable the Bundle
-3. Import PortfolioBundle routing
-4. Configure a pagination
+1. Add StfalconPortfolioBundle in your composer.json
+2. Enable the bundle
+3. Import bundle routing
+4. Configure bundle
 5. Update your database schema
 
-### Step 1: Add PortfolioBundle in your composer.json
+### Step 1: Add StfalconPortfolioBundle in your composer.json
 
 ```js
 {
     "require": {
-        "stfalcon/portfolio-bundle": "*"
+        "stfalcon/portfolio-bundle": "dev-master"
     }
 }
 ```
 
+Now tell composer to download the bundle by running the command:
+
+``` bash
+$ php composer.phar update stfalcon/portfolio-bundle
+```
+
+Composer will install the bundle to your project's `vendor/stfalcon` directory.
+
 ### Step 2: Enable the bundle
 
 Finally, enable the bundle in the kernel:
@@ -52,11 +56,30 @@ public function registerBundles()
     $bundles = array(
         // ...
         new Stfalcon\Bundle\PortfolioBundle\StfalconPortfolioBundle(),
+
+	// for use VichUploaderBundle
+	new Vich\UploaderBundle\VichUploaderBundle(),
+
+        // for use KnpMenuBundle
+        new Knp\Bundle\MenuBundle\KnpMenuBundle(),
+
+        // for use KnpPaginatorBundle
+        new Knp\Bundle\PaginatorBundle\KnpPaginatorBundle(),
+
+        // for use StofDoctrineExtensionsBundle
+        new Stof\DoctrineExtensionsBundle\StofDoctrineExtensionsBundle(),
+
+        // for use SonataAdminBundle
+        new Sonata\CacheBundle\SonataCacheBundle(),
+        new Sonata\BlockBundle\SonataBlockBundle(),
+        new Sonata\AdminBundle\SonataAdminBundle(),
+        new Sonata\DoctrineORMAdminBundle\SonataDoctrineORMAdminBundle(),
+        new Sonata\jQueryBundle\SonatajQueryBundle(),
     );
 }
 ```
 
-### Step 3: Import PortfolioBundle routing
+### Step 3: Import StfalconPortfolioBundle routing
 
 Now that you have installed and activated the bundle, all that is left to do is
 to set the StfalconPortfolioBundle and SonataAdminBundle routings.
@@ -68,7 +91,7 @@ In YAML:
 _stfalcon_portfolio:
     resource: "@StfalconPortfolioBundle/Resources/config/routing.yml"
 ```
-[Routing in SonataAdminBundle](https://github.com/sonata-project/SonataAdminBundle/blob/master/Resources/doc/reference/getting_started.rst#step-1-define-sonataadminbundle-routes)
+[See more info about routing in SonataAdminBundle](https://github.com/sonata-project/SonataAdminBundle/blob/master/Resources/doc/reference/getting_started.rst#step-1-define-sonataadminbundle-routes)
 
 
 
@@ -78,12 +101,20 @@ In YAML:
 
 ``` yaml
 # app/config/config.yml
+# Sonata Configuration
 sonata_block:
     default_contexts: [cms]
     blocks:
         sonata.admin.block.admin_list:
             contexts:   [admin]
 
+# DoctrineExtensionsBundle
+stof_doctrine_extensions:
+    default_locale: en_US
+    orm:
+        default:
+            timestampable: true
+
 vich_uploader:
     db_driver: orm
     mappings:
@@ -101,5 +132,9 @@ Run the following command.
 
 ``` bash
 $ php app/console doctrine:schema:update --force
+$ php app/console assets:install
 ```
-Now that you have completed the installation and configuration of the PortfolioBundle!
+At this point you can already access the admin dashboard by visiting the url: http://yoursite.local/admin/dashboard.
+[Getting started with SonataAdminBundle](http://sonata-project.org/bundles/admin/2-0/doc/reference/getting_started.html)
+
+Now that you have completed the installation and configuration of the StfalconPortfolioBundle!