This repository has been archived by the owner on Feb 12, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 276
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c3448ea
commit c453291
Showing
1 changed file
with
13 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,61 +1,42 @@ | ||
| # [laravel-sitemap](https://laravelium.com) package | ||
| # [laravel-sitemap](https://gitlab.com/Laravelium/Sitemap) package | ||
|
|
||
| [](https://packagist.org/packages/roumen/sitemap) [](https://packagist.org/packages/roumen/sitemap) [](https://travis-ci.org/Laravelium/laravel-sitemap) [](https://packagist.org/packages/roumen/sitemap) | ||
|
|
||
| A not so simple sitemap generator for Laravel 5. | ||
| A not so simple sitemap generator for Laravel. | ||
|
|
||
|
|
||
| ## Notes | ||
|
|
||
| Branch dev-master is for development and is UNSTABLE! | ||
| - **This repo is moved to [GitLab](https://gitlab.com/Laravelium/Sitemap).** | ||
| - **This repo is renamed to [laravelium/sitemap](https://gitlab.com/Laravelium/Sitemap)** | ||
|
|
||
| ## Installation | ||
|
|
||
| Run the following command and provide the latest stable version (e.g v2.8.1) : | ||
| Run the following command and provide the latest stable version (e.g v3.0.1) : | ||
|
|
||
| ```bash | ||
| composer require roumen/sitemap | ||
| composer require laravelium/sitemap | ||
| ``` | ||
|
|
||
| or add the following to your `composer.json` file : | ||
|
|
||
| #### For Laravel 5.6 | ||
| #### For Laravel 5.7 | ||
| ```json | ||
| "roumen/sitemap": "2.8.*" | ||
| "laravelium/sitemap": "3.0.*" | ||
| ``` | ||
|
|
||
| #### For Laravel 5.5 | ||
| #### For Laravel 5.6 | ||
| ```json | ||
| "roumen/sitemap": "2.7.*" | ||
| "laravelium/sitemap": "2.8.*" | ||
| ``` | ||
|
|
||
| #### For Laravel 5.4 and lower | ||
| #### For Laravel 5.5 | ||
| ```json | ||
| "roumen/sitemap": "2.6.*" | ||
| ``` | ||
|
|
||
| If you are using laravel 5.5 or higher you can skip the service provider registration! | ||
|
|
||
| #### for Laravel 5.4 and lower register this service provider with Laravel : | ||
| ```php | ||
| Roumen\Sitemap\SitemapServiceProvider::class, | ||
| "laravelium/sitemap": "2.7.*" | ||
| ``` | ||
|
|
||
| Publish needed assets (styles, views, config files) : | ||
|
|
||
| ```bash | ||
| php artisan vendor:publish --provider="Roumen\Sitemap\SitemapServiceProvider" | ||
| php artisan vendor:publish --provider="Laravelium\Sitemap\SitemapServiceProvider" | ||
| ``` | ||
| *Note:* Composer won't update them after `composer update`, you'll need to do it manually! | ||
|
|
||
| ## Examples | ||
|
|
||
| - [How to generate dynamic sitemap (with optional caching)](https://github.com/Laravelium/laravel-sitemap/wiki/Dynamic-sitemap) | ||
|
|
||
| - [How to generate BIG sitemaps (with more than 1M items)](https://github.com/Laravelium/laravel-sitemap/wiki/Generate-BIG-sitemaps) | ||
|
|
||
| - [How to generate sitemap to a file](https://github.com/Laravelium/laravel-sitemap/wiki/Generate-sitemap) | ||
|
|
||
| - [How to use multiple sitemaps with sitemap index](https://github.com/Laravelium/laravel-sitemap/wiki/Sitemap-index) | ||
|
|
||
| and more in the [Wiki](https://github.com/Laravelium/laravel-sitemap/wiki). |