Skip to content
Permalink
Browse files

Added upgrade guide from 4.x to 5.x

  • Loading branch information...
andrey-helldar committed Mar 21, 2019
1 parent 9634df1 commit 99e7ca25fc8a5936a0fa2a01a67b81118dd8ff89
Showing with 26 additions and 1 deletion.
  1. +2 −1 .gitattributes
  2. +6 −0 README.md
  3. +18 −0 guides/UPGRADE_4X_TO_5X.md
@@ -8,4 +8,5 @@
.styleci.yml export-ignore
.travis.yml export-ignore
phpunit.xml.dist export-ignore
tests export-ignore
tests export-ignore
guides export-ignore
@@ -16,6 +16,7 @@ A simple sitemap generator for PHP Framework.
## Content

* [Installation](#installation)
* [Upgrade guide](#upgrade-guides)
* [Configuration](#configuration)
* [Using](#using)
* [Manual](#manual)
@@ -61,6 +62,11 @@ php artisan vendor:publish --provider="Helldar\Sitemap\ServiceProvider"
Now you can use a `app('sitemap')` method.


## Upgrade Guides

* [Upgrading from 4.x to 5.x](guides/UPGRADE_4X_TO_5X.md)


## Configuration

To configure the generation, you need to fill the `models` array in the `config/sitemap.php` file:
@@ -0,0 +1,18 @@
# Upgrade from 4.x to 5.x

### Updating Dependencies

Update your `andrey-helldar/sitemap` dependency to `^5.0` in your `composer.json` file.

Update dependencies with the command:
```
composer update
```


### Config

* Replace `formatOutput` option to `format_output` in [config/sitemap.php](src/config/sitemap.php) file.


Yes, that's all 😊

0 comments on commit 99e7ca2

Please sign in to comment.
You can’t perform that action at this time.