Skip to content

Commit

Permalink
Update docs for release
Browse files Browse the repository at this point in the history
  • Loading branch information
MGatner committed Nov 25, 2021
1 parent 237690c commit 8bd5200
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Lightweight theme manager for CodeIgniter 4
[![](https://github.com/tattersoftware/codeigniter4-themes/workflows/PHPUnit/badge.svg)](https://github.com/tattersoftware/codeigniter4-themes/actions/workflows/test.yml)
[![](https://github.com/tattersoftware/codeigniter4-themes/workflows/PHPStan/badge.svg)](https://github.com/tattersoftware/codeigniter4-themes/actions/workflows/analyze.yml)
[![](https://github.com/tattersoftware/codeigniter4-themes/workflows/Deptrac/badge.svg)](https://github.com/tattersoftware/codeigniter4-themes/actions/workflows/inspect.yml)
[![Coverage Status](https://coveralls.io/repos/github/tattersoftware/codeigniter4-themes/badge.svg?branch=develop)](https://coveralls.io/github/organization/name?branch=develop)
[![Coverage Status](https://coveralls.io/repos/github/tattersoftware/codeigniter4-themes/badge.svg?branch=develop)](https://coveralls.io/github/tattersoftware/codeigniter4-themes?branch=develop)

## Quick Start

Expand Down
8 changes: 6 additions & 2 deletions UPGRADING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,9 @@
## Version 1 to 2
***

* Now uses `Tatter\Assets` for handling its files, so the root folder for theme paths is now `config('Assets')->directory` (default: `FCPATH . 'assets/'`)
* Switches to `Tatter\Preferences` for managing persistent settings which strongly recommends `codeigniter4/authentication-implementation`
> Note: This is a complete refactor! Please be sure to read the docs carefully before upgrading.
* Uses `Tatter\Assets` for handling its files, so the root folder for theme paths is now `config('Assets')->directory` (default: `FCPATH . 'assets/'`)
* Uses `Tatter\Preferences` for managing persistent settings which strongly recommends `codeigniter4/authentication-implementation`
* Asset injection is now handled by the `ThemesFilter`; remove any references to the tag views and read the docs to set up the filter
* Theme settings now track based on the theme name instead of its ID so pay attention to naming

0 comments on commit 8bd5200

Please sign in to comment.