☕ Update Docs

LICENSE.md

@@ -0,0 +1,116 @@
+CC0 1.0 Universal
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator and
+subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for the
+purpose of contributing to a commons of creative, cultural and scientific
+works ("Commons") that the public can reliably and without fear of later
+claims of infringement build upon, modify, incorporate in other works, reuse
+and redistribute as freely as possible in any form whatsoever and for any
+purposes, including without limitation commercial purposes. These owners may
+contribute to the Commons to promote the ideal of a free culture and the
+further production of creative, cultural and scientific works, or to gain
+reputation or greater distribution for their Work in part through the use and
+efforts of others.
+
+For these and/or other purposes and motivations, and without any expectation
+of additional consideration or compensation, the person associating CC0 with a
+Work (the "Affirmer"), to the extent that he or she is an owner of Copyright
+and Related Rights in the Work, voluntarily elects to apply CC0 to the Work
+and publicly distribute the Work under its terms, with knowledge of his or her
+Copyright and Related Rights in the Work and the meaning and intended legal
+effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not limited
+to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display, communicate,
+  and translate a Work;
+
+  ii. moral rights retained by the original author(s) and/or performer(s);
+
+  iii. publicity and privacy rights pertaining to a person's image or likeness
+  depicted in a Work;
+
+  iv. rights protecting against unfair competition in regards to a Work,
+  subject to the limitations in paragraph 4(a), below;
+
+  v. rights protecting the extraction, dissemination, use and reuse of data in
+  a Work;
+
+  vi. database rights (such as those arising under Directive 96/9/EC of the
+  European Parliament and of the Council of 11 March 1996 on the legal
+  protection of databases, and under any national implementation thereof,
+  including any amended or successor version of such directive); and
+
+  vii. other similar, equivalent or corresponding rights throughout the world
+  based on applicable law or treaty, and any national implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention of,
+applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and
+unconditionally waives, abandons, and surrenders all of Affirmer's Copyright
+and Related Rights and associated claims and causes of action, whether now
+known or unknown (including existing as well as future claims and causes of
+action), in the Work (i) in all territories worldwide, (ii) for the maximum
+duration provided by applicable law or treaty (including future time
+extensions), (iii) in any current or future medium and for any number of
+copies, and (iv) for any purpose whatsoever, including without limitation
+commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes
+the Waiver for the benefit of each member of the public at large and to the
+detriment of Affirmer's heirs and successors, fully intending that such Waiver
+shall not be subject to revocation, rescission, cancellation, termination, or
+any other legal or equitable action to disrupt the quiet enjoyment of the Work
+by the public as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason be
+judged legally invalid or ineffective under applicable law, then the Waiver
+shall be preserved to the maximum extent permitted taking into account
+Affirmer's express Statement of Purpose. In addition, to the extent the Waiver
+is so judged Affirmer hereby grants to each affected person a royalty-free,
+non transferable, non sublicensable, non exclusive, irrevocable and
+unconditional license to exercise Affirmer's Copyright and Related Rights in
+the Work (i) in all territories worldwide, (ii) for the maximum duration
+provided by applicable law or treaty (including future time extensions), (iii)
+in any current or future medium and for any number of copies, and (iv) for any
+purpose whatsoever, including without limitation commercial, advertising or
+promotional purposes (the "License"). The License shall be deemed effective as
+of the date CC0 was applied by Affirmer to the Work. Should any part of the
+License for any reason be judged legally invalid or ineffective under
+applicable law, such partial invalidity or ineffectiveness shall not
+invalidate the remainder of the License, and in such case Affirmer hereby
+affirms that he or she will not (i) exercise any of his or her remaining
+Copyright and Related Rights in the Work or (ii) assert any associated claims
+and causes of action with respect to the Work, in either case contrary to
+Affirmer's express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+  a. No trademark or patent rights held by Affirmer are waived, abandoned,
+  surrendered, licensed or otherwise affected by this document.
+
+  b. Affirmer offers the Work as-is and makes no representations or warranties
+  of any kind concerning the Work, express, implied, statutory or otherwise,
+  including without limitation warranties of title, merchantability, fitness
+  for a particular purpose, non infringement, or the absence of latent or
+  other defects, accuracy, or the present or absence of errors, whether or not
+  discoverable, all to the greatest extent permissible under applicable law.
+
+  c. Affirmer disclaims responsibility for clearing rights of other persons
+  that may apply to the Work or any use thereof, including without limitation
+  any person's Copyright and Related Rights in the Work. Further, Affirmer
+  disclaims responsibility for obtaining any necessary consents, permissions
+  or other rights required for any use of the Work.
+
+  d. Affirmer understands and acknowledges that Creative Commons is not a
+  party to this document and has no duty or obligation with respect to this
+  CC0 or use of the Work.
+
+For more information, please see
+<http://creativecommons.org/publicdomain/zero/1.0/>

README.md

@@ -1,20 +1,26 @@
+# Laravel-Themevel
+
+Themevel is a Laravel 5 theme and asset management. You can easily integrate this package with any Laravel based project.
 
 ### Features
 
 * Add multiple theme support
 * Child theme support
-* Parent Asset finding support
-* Translator support
+* Theme asset or parent asset finding support
+* Theme translator support
+* Multiple theme config extension
+* Multiple theme changelog extension
+* Simple command to create theme
 
 ### Installation
 
-Themevel is a Larravel package so you can install it via composer. Run this command in your terminal from your project directory.
+Themevel is a Laravel package so you can install it via composer. Run this command in your terminal from your project directory.
 
-```
+```ssh
 composer require shipu/themevel
 ```
 
-Wait for a while, Composer will automatically install Talk in your project.
+Wait for a while, Composer will automatically install Themevel in your project.
 
 ### Configuration
 
@@ -35,29 +41,159 @@ Now run this command in your terminal to publish this package resources
 ```
 php artisan vendor:publish --provider="Shipu\Themevel\Providers\ThemevelServiceProvider"
 ```
- Please see the API Doc.
 
-### API List
+### Create theme
+Run this command in your terminal from your project directory.
+
+```ssh
+php artisan theme:create your_theme_name
+```
 
+Now Please see the API List Doc.
 
+### API List
 - [set](https://github.com/shipu/themevel#set)
 - [get](https://github.com/shipu/themevel#get)
 - [current](https://github.com/shipu/themevel#current)
 - [all](https://github.com/shipu/themevel#all)
 - [has](https://github.com/shipu/themevel#has)
-- [lang](https://github.com/shipu/themevel#lang)
 - [getThemeInfo](https://github.com/shipu/themevel#getThemeInfo)
 - [assets](https://github.com/shipu/themevel#assets)
+- [lang](https://github.com/shipu/themevel#lang)
 
-### Route
+### set
 
+For switching current theme you can use `set` method.
+
+```php
+Theme::set('theme-name');
+```
+
+### get
+
+For getting current theme details you can use `get` method. 
+
+```php
+Theme::get(); // return Array
+```
+you can also get particular theme details.
+```php
+Theme::get('theme-name'); // return Array
+```
+
+```php
+Theme::get('theme-name', true); // return Collection
+```
+
+### current
+
+Retrieve current theme's name
+
+```php
+Theme::current(); // return string
+```
+
+### all
+
+Retrieve All Theme Information
+
+```php
+Theme::all(); // return Array
+```
+
+### has
+
+For getting theme exist or not
+
+```php
+Theme::has(); // return bool
+```
+
+### getThemeInfo
+
+For getting theme exist or not
+
+```php
+$themeInfo = Theme::getThemeInfo('theme-name'); // return Collection
+
+$themeName = $themeInfo->get('name');
+// or
+$themeName = $themeInfo['name'];
+```
+Also fallback support
+```php
+$themeInfo = Theme::getThemeInfo('theme-name'); // return Collection
+
+$themeName = $themeInfo->get('changelog.versions');
+// or
+$themeName = $themeInfo['changelog.versions'];
+// or you can also call like as multi dimention
+$themeName = $themeInfo['changelog']['versions'];
+```
+### assets
+
+For binding theme asset you can use `assets` method
+
+```php
+Theme::assets('your_asset_path'); // return string
+```
+It's Generate `BASE_URL/theme_roots/your_active_theme_name/assets/your_asset_path`
+
+If your_asset_path not exist then it's find to active theme immediate parent assets folder. Look Like `BASE_URL/theme_roots/your_active_theme_parent_name/assets/your_asset_path`
+
+For Using Helper
+```php
+themes('your_asset_path'); // return string
+```
+
+If You you want to bind specific theme assets:
+```php
+Theme::assets('your_theme_name:your_asset_path'); // return string
+//or 
+themes('your_theme_name:your_asset_path'); // return string
+```
+
+**Suppose you want to bind `app.css` in your blade. Then below code can be applicable**
+```php
+<link rel="stylesheet" href="{{ themes('app.css') }}">
+```
+Specific theme assets:
+```php
+<link rel="stylesheet" href="{{ themes('your_theme_name:app.css') }}">
+```
+### lang
+
+The `lang` method translates the given language line using your current **theme** [localization files](https://laravel.com/docs/5.4/localization):
+```php
+echo Theme::lang('content.title'); // return string
+// or
+echo lang('content.title'); // return string
+```
+If You you want to bind specific theme assets:
+```php
+echo Theme::lang('your_theme_name::your_asset_path'); // return string
+//or 
+echo lang('your_theme_name::your_asset_path'); // return string
+```
+
+### How to use in Route
 ```
 Route::get('/', function () {
     Theme::set('your_themen_name');
     return view('welcome');
 });
 ```
-### 'theme' RouteMiddleware
+This will firstly check if there is a welcome.blade.php in current theme directory. If none is found then it checks parent theme, and finally falls back to default laravel views location.
+
+If You you want to specific theme view:
+```
+Route::get('/', function () {
+    Theme::set('your_theme_name');
+    return view('your_theme_name::welcome');
+});
+```
+
+### Set theme using route middleware
 A helper middleware is included out of the box if you want to define a Theme per route. To use it:
 
 First register it in app\Http\Kernel.php:
@@ -70,13 +206,13 @@ protected $routeMiddleware = [
 ```
 Now you can apply the middleware to a route or route-group. Eg:
 ```
-Route::group(['prefix' => 'admin', 'middleware'=>'setTheme:ADMIN_THEME'], function() {
+Route::group(['prefix' => 'admin', 'middleware'=>'theme:Your_theme_name'], function() {
     // ... Add your routes here 
-    // The ADMIN_THEME will be applied.
+    // The Your_theme_name will be applied.
 });
 ```
 
-### WebMiddleware
+### Set theme using web middleware
 A helper middleware is included out of the box if you want to define a Theme per route. To use it:
 
 First register it in app\Http\Kernel.php:
@@ -90,9 +226,10 @@ protected $middlewareGroups = [
     // ...
 ];
 ```
+Theme set from `config/theme.php` .
 
 ## Support for this project
 Hey dude! Help me out for a couple of :beers:!
 
-[![Beerpay](https://beerpay.io/nahid/talk/badge.svg?style=beer-square)](https://beerpay.io/nahid/talk)  [![Beerpay](https://beerpay.io/nahid/talk/make-wish.svg?style=flat-square)](https://beerpay.io/nahid/talk?focus=wish)
+[![Beerpay](https://beerpay.io/Shipu/themevel/badge.svg?style=beer)](https://beerpay.io/Shipu/themevel) [![Beerpay](https://beerpay.io/Shipu/themevel/make-wish.svg?style=flat-square)](https://beerpay.io/Shipu/themevel?focus=wish) 
 

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "shipu/themevel",
-    "description": "Theme and asset management for laravel",
-    "keywords": ["theme", "multi", "themevel", "asset", "management", "laravel", "lumen"],
+    "description": "Theme and asset management for laravel 5",
+    "keywords": ["theme", "child-theme", "multi", "themevel", "asset", "management", "laravel", "lumen"],
     "homepage": "https://github.com/shipu/themevel",
     "license": "CC(3.0)",
     "authors": [