Skip to content
This repository has been archived by the owner. It is now read-only.
Permalink
Browse files

updated README.md

  • Loading branch information...
Damianoff committed Sep 5, 2018
1 parent c3448ea commit c45329150edd3149bf4857a0322b8e437f8b8b09
Showing with 13 additions and 32 deletions.
  1. +13 −32 README.md
@@ -1,61 +1,42 @@
# [laravel-sitemap](https://laravelium.com) package
# [laravel-sitemap](https://gitlab.com/Laravelium/Sitemap) package

[![Latest Stable Version](https://poser.pugx.org/roumen/sitemap/version.png)](https://packagist.org/packages/roumen/sitemap) [![Total Downloads](https://poser.pugx.org/roumen/sitemap/d/total.png)](https://packagist.org/packages/roumen/sitemap) [![Build Status](https://travis-ci.org/Laravelium/laravel-sitemap.png?branch=master)](https://travis-ci.org/Laravelium/laravel-sitemap) [![License](https://poser.pugx.org/roumen/sitemap/license.png)](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).

0 comments on commit c453291

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