Updating Readme to highlight the deletables key change from models

Author: josecanhelp

.phpunit.result.cache

@@ -0,0 +1 @@
+C:30:"PHPUnit\Runner\TestResultCache":1341:{a:2:{s:7:"defects";a:0:{}s:5:"times";a:15:{s:77:"QuicksandDeleteTest::it_deletes_old_records_using_the_older_models_key_config";d:0.346;s:43:"QuicksandDeleteTest::it_deletes_old_records";d:0.018;s:60:"QuicksandDeleteTest::it_deletes_old_records_for_pivot_tables";d:0.019;s:53:"QuicksandDeleteTest::it_does_not_delete_newer_records";d:0.038;s:79:"QuicksandDeleteTest::it_deletes_newer_records_when_deletion_period_is_overriden";d:0.023;s:70:"QuicksandDeleteTest::it_does_not_delete_newer_records_for_pivot_tables";d:0.032;s:96:"QuicksandDeleteTest::it_deletes_newer_records_for_pivot_tables_when_deletion_period_is_overriden";d:0.024;s:60:"QuicksandDeleteTest::it_can_combine_pivot_tables_with_models";d:0.043;s:59:"QuicksandDeleteTest::it_deletes_records_with_a_global_scope";d:0.049;s:81:"QuicksandDeleteTest::it_throws_exception_if_soft_deletes_are_not_enabled_on_model";d:0.016;s:85:"QuicksandDeleteTest::it_will_delete_rows_from_multiple_tables_if_config_is_set_for_it";d:0.028;s:83:"QuicksandDeleteTest::it_does_not_delete_anything_if_days_before_deletion_is_not_set";d:0.023;s:61:"QuicksandDeleteTest::it_writes_to_logs_if_entries_are_deleted";d:0.056;s:69:"QuicksandDeleteTest::it_does_not_write_to_logs_if_log_is_set_to_false";d:0.028;s:80:"QuicksandDeleteTest::it_does_not_write_to_logs_if_there_are_no_deletable_records";d:0.026;}}}

README.md

@@ -29,7 +29,7 @@ Quicksand is an Artisan command that you can run in your scheduler daily.
 4. Edit your config. Define which classes and/or pivot tables you'd like to have Quicksand clean up for you, how many days Quicksand should wait to clean up, and whether or not the results should be logged. The default `'days'` until cleaning up is overridable by specifying a `'days'` key when registering a model or pivot table:
 
     1. _Note: Quicksand will disregard any global scopes applied to models when deleting._
-
+    2. _Note: Prior to version 2.3 the `deletables` configuration key was named `models` and did not support pivot tables._
 
     ```php
     'days' => 30,