🎉 Release 2.0.0

Author: julienbourdeau

CHANGELOG.md

@@ -1,9 +1,33 @@
 # Changelog
 
+## 2.0.0
+
+* Better message in console
+* Do not use prefix in file names
+
+    In a typical workflow, you would use a different `scout.prefix` for
+    each environment. Generally, you work on dev env, tweak settings in the
+    dashboard, save them to your project with `php artisan algolia:settings:backup`
+    and push them to your new index with you go to prod env.
+    Because in v1 we would link all resources to the full index, if you
+    use a different prefix, you weren't able to do this.
+    In case you want to keep the behavior like in v1, pass the `--prefix` option
+    to the 2 commands.
+    
+    See [issue #14](https://github.com/algolia/laravel-scout-settings/issues/14)
+    
+* Introduce new IndexResourceRepository service class
+    
+    This service allows you to read and write files with your settings,
+    synonyms, rules via simple methods. This class doesn't interact with
+    Algolia's API but with files in your `resources` folder.
+    Thanks @qrazi
+    
+
 ### 1.0.1
 
 * Move UserAgent definition to ServiceProvider
-* Add compatibility withs Scout ^4.0 (Thanks to @tomcoonen)
+* Add compatibility with Scout ^4.0 (Thanks to @tomcoonen)
 
 ## 1.0.0
 

README.md

@@ -2,7 +2,8 @@
 
 **Import/Export Algolia settings, synonyms and query rules into your Laravel Scout project.**
 
-The easiest way to manage your settings is usually to go to your Algolia dashboard because it has a nice UI and you can test the relevancy directly there.
+The easiest way to manage your settings is usually to go to your Algolia dashboard because it
+has a nice UI and you can test the relevancy directly there.
 
 Once you fine tuned your configuration, you may want to add it to your project.
 
@@ -11,7 +12,7 @@ This package adds two Laravel commands to your project:
 - one to save your settings, synonyms and query rules into JSON files
 - one to push everything back to Algolia
 
-This has 3 majors advantages:
+This has 3 major advantages:
 
 1. You can version your configuration with your VCS
 2. You can set up a new environment or restore backups easily
@@ -27,48 +28,66 @@ composer require algolia/laravel-scout-settings
 
 #### Laravel 5.5
 
-If you use Laravel 5.5, this package will take advantage of the [Package Auto-Discovery](https://medium.com/@taylorotwell/package-auto-discovery-in-laravel-5-5-ea9e3ab20518) feature.
+If you use Laravel 5.5, this package will take advantage of the 
+[Package Auto-Discovery](https://medium.com/@taylorotwell/package-auto-discovery-in-laravel-5-5-ea9e3ab20518) feature.
 Nothing more to do to register the commands.
 
 #### Laravel 5.4 and prior
 
-If you use an older version of Laravel, you will have to add the Service Provider to the `providers` array in `config/app.php`
+If you use an older version of Laravel, you will have to add the Service Provider to
+the `providers` array in `config/app.php`
 
 ```php
 Algolia\Settings\ServiceProvider::class,
 ```
 
 ## Usage
 
-You will now get two new commands available in `artisan`. They both take a model's fully qualified class name, just like Laravel Scout does to import/flush data.
+You will now get two new commands available in `artisan`. They both take a model's fully
+qualified class name, just like Laravel Scout does to import/flush data.
 
 The following example assume you have an `App\Contact` class, which uses the `Searchable` trait.
 
-Note: Scout allows you to customize the index name with the [`searchableAs()`](https://laravel.com/docs/scout#configuring-model-indexes) method. This package will follow this naming convention.
+Note: Scout allows you to customize the index name with the
+[`searchableAs()`](https://laravel.com/docs/scout#configuring-model-indexes) method. This package
+will follow this naming convention.
 
 ### Backing up settings (Project ⬅️ Algolia)
 
-The following command will export all the settings and synonyms from the `App\Contact`'s index into the following files:
+The following command will export all the settings and synonyms from the `App\Contact`'s
+index into the following files:
 
-* **Settings**: `resources/algolia-settings/prefix_index_name.json`
-* **Synonyms**: `resources/algolia-settings/prefix_index_name-synonyms.json`
-* **Query Rules**: `resources/algolia-settings/prefix_index_name-rules`
+* **Settings**: `resources/algolia-settings/index_name.json`
+* **Synonyms**: `resources/algolia-settings/index_name-synonyms.json`
+* **Query Rules**: `resources/algolia-settings/index_name-rules`
 
 ```
 php artisan algolia:settings:backup "App\Contact"
 ```
 
+Note that if you want to add the prefix to your file names (which was the default behavior in v1),
+you can pass the `--prefix` option.
+
+```
+php artisan algolia:settings:backup "App\Contact" --prefix
+```
+
 ### Pushing settings (Project ➡️ Algolia)
 
-The following command will read all the settings, synonyms and query rules from the files in `resources/algolia-settings/` and import them into Algolia's index.
+The following command will read all the settings, synonyms and query rules from the 
+files in `resources/algolia-settings/` and import them into Algolia's index.
 
 ```
 php artisan algolia:settings:push "App\Contact"
 ```
 
+You can also pass the `--prefix` option, just like the backup command.
+
 ### Customizing directory
 
-By default, settings, rules and synonyms are saved into the `resources/algolia-settings`. The directory can be customized by the defining an environment variable named `ALGOLIA_SETTINGS_FOLDER`. For example, the following command will save all the index resources into `resources/indexmeta`.
+By default, settings, rules and synonyms are saved into the `resources/algolia-settings`.
+The directory can be customized by the defining an environment variable named `ALGOLIA_SETTINGS_FOLDER`.
+For example, the following command will save all the index resources into `resources/indexmeta`.
 
 ```
 ALGOLIA_SETTINGS_FOLDER=indexmeta php artisan algolia:settings:backup

src/ServiceProvider.php

@@ -12,7 +12,7 @@
 
 final class ServiceProvider extends LaravelServiceProvider
 {
-    const VERSION = '1.0.0';
+    const VERSION = '2.0.0';
 
     public function boot()
     {