update readme and so on

Author: MahdiMajidzadeh

CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+All notable changes to `laravel-kavenegar` will be documented in this file.
+
+Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) principles.

README.md

@@ -1,83 +1,37 @@
-# :package_name
-
-[![Latest Version on Packagist][ico-version]][link-packagist]
-[![Software License][ico-license]](LICENSE.md)
-[![Build Status][ico-travis]][link-travis]
-[![Coverage Status][ico-scrutinizer]][link-scrutinizer]
-[![Quality Score][ico-code-quality]][link-code-quality]
-[![Total Downloads][ico-downloads]][link-downloads]
-
-**Note:** Replace ```:author_name``` ```:author_username``` ```:author_website``` ```:author_email``` ```:vendor``` ```:package_name``` ```:package_description``` with their correct values in [README.md](README.md), [CHANGELOG.md](CHANGELOG.md), [CONTRIBUTING.md](CONTRIBUTING.md), [LICENSE.md](LICENSE.md) and [composer.json](composer.json) files, then delete this line. You can run `$ php prefill.php` in the command line to make all replacements at once. Delete the file prefill.php as well.
-
-This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what
-PSRs you support to avoid any confusion with users and contributors.
-
-## Structure
-
-If any of the following are applicable to your project, then the directory structure should follow industry best practises by being named the following.
-
-```
-bin/        
-config/
-src/
-tests/
-vendor/
-```
+# Persianalize
 
+**Persianalize** use to normalize Persian input and remove arabic and other similar characters.
 
 ## Install
 
 Via Composer
 
 ``` bash
-$ composer require :vendor/:package_name
+$ composer require mahdimajidzadeh/persianalize
 ```
 
-## Usage
+If you do not run Laravel 5.5 (or higher), then add the service provider in config/app.php:
 
 ``` php
-$skeleton = new League\Skeleton();
-echo $skeleton->echoPhrase('Hello, League!');
+MahdiMajidzadeh\Persianalize\PersianalizeServiceProvider:class
 ```
 
-## Change log
-
-Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
+If you do run the package on Laravel 5.5+, package auto-discovery takes care of the magic of adding the service provider.
 
-## Testing
-
-``` bash
-$ composer test
-```
-
-## Contributing
-
-Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) for details.
-
-## Security
+## Usage
 
-If you discover any security related issues, please email :author_email instead of using the issue tracker.
+``` php
+$result = Persian::numbers_fa('123٤٥٦'); // return ۱۲۳۴۵۶
 
-## Credits
+$result = Persian::numbers_en('۱۲۳٤٥٦'); // return 123456
 
-- [:author_name][link-author]
-- [All Contributors][link-contributors]
+$result = Persian::text('ي ڲ ڬ'); // return ی گ ک
 
-## License
+$result = Persian::persian($text); // make texts and numbers Persian 
 
-The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
+$result = Persian::standard($text); // make texts Persian and numbers English 
+```
 
-[ico-version]: https://img.shields.io/packagist/v/:vendor/:package_name.svg?style=flat-square
-[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
-[ico-travis]: https://img.shields.io/travis/:vendor/:package_name/master.svg?style=flat-square
-[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/:vendor/:package_name.svg?style=flat-square
-[ico-code-quality]: https://img.shields.io/scrutinizer/g/:vendor/:package_name.svg?style=flat-square
-[ico-downloads]: https://img.shields.io/packagist/dt/:vendor/:package_name.svg?style=flat-square
+## Change log
 
-[link-packagist]: https://packagist.org/packages/:vendor/:package_name
-[link-travis]: https://travis-ci.org/:vendor/:package_name
-[link-scrutinizer]: https://scrutinizer-ci.com/g/:vendor/:package_name/code-structure
-[link-code-quality]: https://scrutinizer-ci.com/g/:vendor/:package_name
-[link-downloads]: https://packagist.org/packages/:vendor/:package_name
-[link-author]: https://github.com/:author_username
-[link-contributors]: ../../contributors
+Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

composer.json

@@ -19,38 +19,18 @@
     ],
     "require": {
         "illuminate/support": ">=5.1",
-        "php": ">=5.5.9"
-    },
-    "require-dev": {
-        "phpunit/phpunit" : ">=5.4.3",
-        "squizlabs/php_codesniffer": "^2.3"
+        "php" : "~5.6|~7.0",
     },
     "autoload": {
         "psr-4": {
             "MahdiMajidzadeh\\Persianalize\\": "src"
         }
     },
-    "autoload-dev": {
-        "psr-4": {
-            "MahdiMajidzadeh\\Persianalize\\": "tests"
-        }
-    },
-    "scripts": {
-        "test": "phpunit",
-        "check-style": "phpcs -p --standard=PSR2 --runtime-set ignore_errors_on_exit 1 --runtime-set ignore_warnings_on_exit 1 src tests",
-        "fix-style": "phpcbf -p --standard=PSR2 --runtime-set ignore_errors_on_exit 1 --runtime-set ignore_warnings_on_exit 1 src tests"
-    },
     "extra": {
-        "branch-alias": {
-            "dev-master": "1.0-dev"
-        },
         "laravel": {
             "providers": [
                 "MahdiMajidzadeh\\Persianalize\\PersianalizeServiceProvider"
             ]
         }
-    },
-    "config": {
-        "sort-packages": true
     }
 }

prefill.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace mahdimajidzadeh\persianalize;
+namespace MahdiMajidzadeh\Persianalize;
 
 class Persian
 {

src/Persian.php

@@ -1,26 +1,16 @@
 <?php
 
-namespace mahdiMajidzadeh\persianalize;
+namespace MahdiMajidzadeh\Persianalize;
 
 use Illuminate\Support\ServiceProvider;
 
 class PersianalizeServiceProvider extends ServiceProvider
 {
-    /**
-     * Perform post-registration booting of services.
-     *
-     * @return void
-     */
     public function boot()
     {
         //
     }
 
-    /**
-     * Register any package services.
-     *
-     * @return void
-     */
     public function register()
     {
         //