Refactor package name and file paths to follow naming conventions and improve readability.

Author: thejmitchener

README.md

@@ -1,4 +1,4 @@
-# Fuelviews Laravel sitemap package
+# Fuelviews laravel sitemap package
 
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/fuelviews/laravel-sitemap.svg?style=flat-square)](https://packagist.org/packages/fuelviews/laravel-sitemap)
 [![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/fuelviews/laravel-sitemap/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/fuelviews/laravel-sitemap/actions?query=workflow%3Arun-tests+branch%3Amain)
@@ -17,43 +17,83 @@ We highly appreciate you sending us a postcard from your hometown, mentioning wh
 
 ## Installation
 
-You can install the package via composer:
+You can require the package and it's dependencies via composer:
 
 ```bash
 composer require fuelviews/laravel-sitemap
 ```
 
-You can publish and run the migrations with:
+You can install the package with:
 
 ```bash
-php artisan vendor:publish --tag="laravel-sitemap-migrations"
-php artisan migrate
+php artisan sitemap:install
 ```
 
-You can publish the config file with:
+You can manually publish the config file with:
 
 ```bash
-php artisan vendor:publish --tag="laravel-sitemap-config"
+php artisan vendor:publish --provider="Fuelviews\Sitemap\SitemapServiceProvider" --tag="laravel-sitemap-config"
 ```
 
 This is the contents of the published config file:
 
 ```php
 return [
+    /**
+     * Specifies the default filesystem disk that should be used.
+     * The 'public_path' disk is typically used for files that need to be publicly accessible to users.
+     * This setting can influence where files, such as generated sitemaps, are stored by default.
+     */
+    'disk' => 'public',
+
+    /**
+     * Determines whether the index page should be excluded from the sitemap.
+     * Setting this to `true` will exclude the index page, `false` will include it.
+     */
+    'exclude_index' => true,
+
+    /**
+     * Controls whether redirect URLs should be excluded from the sitemap.
+     * When set to `true`, all redirects are excluded to ensure the sitemap only contains direct links.
+     */
+    'exclude_redirects' => true,
+
+    /**
+     * An array of route names to be excluded from the sitemap.
+     * Useful for excluding specific pages that should not be discoverable via search engines.
+     */
+    'exclude_route_names' => [
+    ],
+
+    /**
+     * Specifies paths that should be excluded from the sitemap.
+     * Any routes starting with these paths will not be included in the sitemap, enhancing control over the sitemap contents.
+     */
+    'exclude_paths' => [
+    ],
+
+    /**
+     * An array of full URLs to be excluded from the sitemap.
+     * This allows for fine-grained exclusion of specific pages, such as sitemap files or any other URLs not suitable for search engine indexing.
+     */
+    'exclude_urls' => [
+        '/sitemap.xml',
+        '/pages_sitemap.xml',
+        '/posts_sitemap.xml',
+    ],
 ];
 ```
 
-Optionally, you can publish the views using
+You can generate the sitemap with:
 
 ```bash
-php artisan vendor:publish --tag="laravel-sitemap-views"
+php artisan sitemap:generate
 ```
 
 ## Usage
 
-```php
-$sitemap = new Fuelviews\Sitemap();
-echo $sitemap->echoPhrase('Hello, Fuelviews!');
+```
+To access the sitemap, navigate to your application's URL and append /sitemap.xml to it.For example, if your application is hosted at http://www.example.com, the sitemap can be found at http://www.example.com/sitemap.xml.
 ```
 
 ## Testing
@@ -76,7 +116,9 @@ Please review [our security policy](../../security/policy) on how to report secu
 
 ## Credits
 
-- [thejmitchener](https://github.com/thejmitchener)
+- [Thejmitchener](https://github.com/thejmitchener)
+- [Fuelviews](https://github.com/fuelviews)
+- [Spatie](https://github.com/spatie)
 - [All Contributors](../../contributors)
 
 ## License

composer.json

@@ -1,10 +1,11 @@
 {
     "name": "fuelviews/laravel-sitemap",
-    "description": "Fuelviews Laravel sitemap package",
+    "description": "Fuelviews laravel sitemap package",
     "keywords": [
         "Fuelviews",
         "laravel",
-        "laravel-sitemap"
+        "laravel-sitemap",
+        "'"sitemap"
     ],
     "homepage": "https://github.com/fuelviews/laravel-sitemap",
     "license": "MIT",

config/fv-sitemap.php config/sitemap.php

@@ -23,14 +23,24 @@ public function configurePackage(Package $package): void
          */
         $package
             ->name('laravel-sitemap')
-            ->hasConfigFile('fv-sitemap')
+            ->hasConfigFile()
             ->publishesServiceProvider('SitemapServiceProvider')
             ->hasCommands([
                 SitemapGenerateCommand::class,
                 InstallCommand::class,
             ]);
     }
 
+    /**
+     * TODO
+     */
+    public function boot()
+    {
+        $this->publishes([
+            __DIR__.'/../config/sitemap.php' => config_path('fv-sitemap.php'),
+        ], 'laravel-sitemap-config');
+    }
+
     /**
      * TODO
      */