Updating README.md

Author: bkader

README.md

@@ -1,16 +1,64 @@
-# CI-Theme - CodeIgniter Themes
-I tried a lot of templates and themes libraries and I was satisfy with them but I decided to make my own, as simple as it can get. So here is my library, free to use, like **CodeIgniter**.
-**NOTE**: Sublime text auto completions has been added to the repo.
-## What's CI-Theme?
-CI-Theme is a library that helps you make your CodeIgniter application theme-able :D. Just download it, drop files into their respective folders (__content__ folder is public). Voilà.
+#CodeIgniter Theme Library
+There are plenty of CodeIgniter template library. I tried most of them and I must say that they rock. Though, I had to make my own that suits my needs and that may be easy to implement, easy to understand and easy to use.
 
-## How To Install?
-As I said above, simply drop all given files, configure and voilà, tout est prêt :), everything is set.
+## What is this library about?
+It offers you the possibility to implement theming feature to your CodeIgniter applications with simple folders structure and ease of use (It works even when using **HMVC**).
 
-## What to do after?
-You are given a folder names **content** inside which you have **theme** and **uploads**. All your themes files go under _content/themes_ (simply follow the example of the **default** theme)
+## How to install?
+All you have to do is to download provided files into your CodeIgniter install and you are done. Of course, some configuration need to be done and THEN you are really done.
+
+## Files provided
+This library comes in two (**2**) parts, the first goes into your application folder and the other in your public accessible folder (_public_html_, _www_...)
+
+#### Folders structure
+
+    - application
+	    - config/theme.php
+	    - helpers/theme_helper.php (_NOT NEEDED_)
+	    - libraries/Theme.php
+
+    - content
+	    - common
+	    - themes
+		    - default
+			    - assets/
+			    - views/
+				    - _layouts/
+					    - default.php
+				    - _master/
+					    - default.php
+				    - _modules/
+				    - _partials/
+					    - alert.php
+					    - footer.php
+					    - header.php
+					    - sidebar.php
+		    - semantic (same as above)
+	    - uploads
+Other files are simply either **css**, **js** or **images**.
+
+##Library Methods
+
+ - **set**: sets variables to pass to view files.
+ - **get**: get something from theme config property.
+ - **theme**: changes the current theme.
+ - **master**: changes the master view file to use.
+ - **layout**: use a different layout.
+ - **title**, **description**, **keywords**: set page's meta tags content.
+ - **add_meta**, **meta**: the first one appends a meta tag and the other one displays the full html <meta> tag.
+ - **assets_url** and **uploads_url**: both return the full URL to their respective folders. (_content/assets_ and _content/uploads_)
+ - Methods on **CSS** and **JS** (I use **x** to represente them both):
+	 - **add_x**: adds the file to files list.
+	 - **append_x**: adds the at the beginning of files list.
+	 - **remove_x**: remove a file from files list.
+	 - **replace_x**: replaces a file by a new one.
+	 - **get_x**: returns an array of loaded **X** files.
+	 - **x_url**: returns the full url to **X** file.
+	 - **x**: css() or js() display full html tag with the given file.
+
+## Where are files located?
+CI-Theme library looks for views in a particular order so that everything can be overridden. Here is in order where files should be:
 
-This library works as well when in **HMVC**. It will look for views in the following order:
 #### Views:
 2. themes/**theme_name**/views/_modules/**module_name**/
 3. themes/**theme_name**/views/
@@ -37,6 +85,7 @@ The library will search inside these folders in the following order:
 4. **module_location**/**module_name**/views/_master/
 5. **views_path**/_master/
 
-This was made when using **CodeIgniter version 3.1.6**. Feel free to report anything and suggest any enhancements.
+Feel free to explore the library to know more about it and if you have any questions, I am here to answer as long as I am still alive.
 
-All credits go to owners of any external files used here.
+#CREDITS
+All credits go to their respective owners: **CodeIgniter**, **Bootstrap** and **Semantic-UI**. (and some of it for my work :D)