Skip to content

Commit

Permalink
🔥 update documentation
Browse files Browse the repository at this point in the history
update documentation
  • Loading branch information
Shipu authored Apr 16, 2020
1 parent 96fea6a commit 42ffe52
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,22 @@
[![Latest Unstable Version](https://poser.pugx.org/shipu/themevel/v/unstable)](https://packagist.org/packages/shipu/themevel)
[![License](https://poser.pugx.org/shipu/themevel/license)](https://packagist.org/packages/shipu/themevel)

Themevel is a Laravel 5 theme and asset management package. You can easily integrate this package with any Laravel based project.
Themevel is a Laravel theme and asset management package. You can easily integrate this package with any Laravel based project.

### Features

* Custom theme location
* Custom theme path
* Override theme
* Parent theme support
* Unlimited Parent view finding
* Asset Finding
* Theme translator support
* Multiple theme config extension
* Multiple theme changelog extension
* Artisan console commands
* Theme enable only Specific route via middleware
* Almost everything customizable
* Laravel 7.0+ Support

## Installation

Expand Down Expand Up @@ -107,6 +111,7 @@ php artisan theme:list
- welcome.blade.php
- changelog.yml
- theme.json
- themetwo/
```
You can change `theme.json` and `changelog.yml` name from `config/theme.php`

Expand Down Expand Up @@ -134,6 +139,15 @@ Then run `theme:create` command which describe above.

Now Please see the API List Doc.

## View Finding Flow:

Suppose you want find `welcome.blade.php`
```
- At first check your active theme
- If `welcome.blade.php not found in active theme then search parent recursively
- If `welcome.blade.php not found in parents theme then search laravel default view folder resources/views
```

## API List
- [set](https://github.com/shipu/themevel#set)
- [get](https://github.com/shipu/themevel#get)
Expand Down

0 comments on commit 42ffe52

Please sign in to comment.