read me + publish lang

Author: gcphost

README.md

@@ -1,5 +1,5 @@
-# Laravel 5 Profanity Filter
-Filter profanity, or other words, out of a string using Laravels [localization](https://laravel.com/docs/5.3/localization) feature.
+# Laravel 5 & PHP Profanity Filter
+Filter profanity, or other words, out of a string using Laravels [localization](https://laravel.com/docs/5.3/localization) feature or with any PHP application and some custom coding.
 
 # Installation
 ```
@@ -11,12 +11,7 @@ Register the service providers to enable the package:
 Askedio\Laravel5ProfanityFilter\Providers\ProfanityFilterServiceProvider::class,
 ```
 
-Autoload it:
-```
-composer dumpautoload
-```
-
-# Configure
+## Configure
 ```
 php artisan vendor:publish
 ```
@@ -38,5 +33,37 @@ You can also define things inline
 $string = app('profanityFilter')->replaceWith('#')->replaceFullWords(false)->filter('something with a bad word'));
 ```
 
+# Options
+* `filter($string = string, $details = boolean)` pass a string to be filtered.
+
+  * Enable details to have an array of results returned:
+    ```php
+    [
+      "orig" => "",
+      "clean" => "",
+      "hasMatch" => boolean,
+      "matched" => []
+    ]
+    ```
+* `reset()` reset `replaceWith` and `replaceFullWords` to defaults.
+* `replaceWith(string)` change the chars used to replace filtered strings.
+* `replaceFullWords(boolean)` enable to replace full words, disable to replace partial.
+
+
+# Profanity Filter with PHP
+You can also use this package without Laravel.
+
+```php
+use Askedio\Laravel5ProfanityFilter\ProfanityFilter;
+
+$config = []; // Data from `resources/config/profanity.php`
+$badWordsArray = []; // Data from `resources/lang/[lang]/profanity.php`
+
+$profanityFilter =  new ProfanityFilter($config, $badWordsArray);
+$string = $profanityFilter->filter('something with a bad word');
+```
+
+
+
 # Credits
 This package is based on [banbuilder](https://github.com/snipe/banbuilder).

app/Providers/ProfanityFilterServiceProvider.php

@@ -30,6 +30,9 @@ public function boot()
     {
         $this->loadTranslationsFrom(realpath(__DIR__.'/../../resources/lang'), 'Laravel5ProfanityFilter');
 
-        $this->publishes([realpath(__DIR__.'/../../resources/config/profanity.php') => config_path('profanity.php')], 'config');
+        $this->publishes([
+          realpath(__DIR__.'/../../resources/config/profanity.php') => config_path('profanity.php'),
+          realpath(__DIR__.'/../../resources/lang') => resource_path('lang/vendor/profanity'),
+        ], 'config');
     }
 }