add docs

Author: roshedgostarandev1

README.md

@@ -1 +1,133 @@
-# Transform Laravel requests
+
+<p align="center">
+    <img src="resources/images/diagram.png?raw=true">
+</p>
+
+
+
+# Transform laravel requests
+
+transform laravel requests in an easy way.
+
+## List of contents
+
+- [Install](#install)
+- [How to use](#how-to-use)
+  - [Create a new data transformer](#create-a-new-data-transformer)
+  - [Transform requests](#transform-requests)
+- [Change log](#change-log)
+- [Contributing](#contributing)
+- [Security](#security)
+- [Credits](#credits)
+- [License](#license)
+
+## Install
+
+Via Composer
+
+```bash
+$ composer require shetabit/transform-request
+```
+
+## How to use
+
+#### Create a new data transformer
+
+we use transformers to transform request datas.
+
+you can run the below command in your console in order to create a new data transformer named `TestTransformer`.
+
+```bash
+$ composer php artisan make:transformer TestTransformer
+```
+
+all transformers will be created in `App\Http\Transformers` path.
+
+#### Transformer example:
+
+in all transformers, the `transform` method will transform your data into your ideal one.
+for example we can write the below code in it:
+
+```php
+namespace App\Http\Transformers;
+
+use Shetabit\Transformer\Contracts\TransformerInterface;
+
+class TestTransformer implements TransformerInterface
+{
+    /**
+     * transform given data
+     *
+     * @param array $data
+     * @return array
+     */
+    public function transform(array $data) : array {
+        /*
+            input data :		
+            [
+                'n' => 'mahdi',
+                'f' => 'khanzadi'
+            ]
+
+            transformed data:
+            [
+                'name' => 'mahdi',
+                'family' => 'khanzadi',
+                'username' => 'mahdikhanzadi'
+            ]
+        */
+
+        return [
+            'name' => $data['n'] ?? null,
+            'family' => $data['f'] ?? null,
+            'username' => ($data['n'] ?? null).($data['f'] ?? null)
+        ];
+    }
+}
+```
+
+#### Transform requests
+
+we can use a transformer to transform requests like the below:
+
+```php
+namespace App\Http\Controllers;
+
+use App\Http\Transformers\TestTransformer;
+use Illuminate\Http\Request;
+
+class TestController extends Controller
+{
+    public function __invoke(Request $request) {
+        $data = $request->transform()->get(new TestTransformer());
+        
+        print_r($data)
+    }
+}
+```
+
+## Change log
+
+Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
+
+## Contributing
+
+Please see [CONTRIBUTING](CONTRIBUTING.md) and [CONDUCT](CONDUCT.md) for details.
+
+## Security
+
+If you discover any security related issues, please email khanzadimahdi@gmail.com instead of using the issue tracker.
+
+## Credits
+
+- [Mahdi khanzadi][link-author]
+- [All Contributors][link-contributors]
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
+
+[link-packagist]: https://packagist.org/packages/shetabit/transform-request
+[link-code-quality]: https://scrutinizer-ci.com/g/shetabit/transform-request
+[link-author]: https://github.com/khanzadimahdi
+[link-contributors]: ../../contributors

resources/diagrams/diagram(created by: diagram.io).drawio

@@ -0,0 +1 @@
+<mxfile modified="2019-08-27T08:50:51.130Z" host="www.draw.io" agent="Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:68.0) Gecko/20100101 Firefox/68.0" etag="LbEaOdvPORbH6PZggIga" version="11.2.3" type="device" pages="1"><diagram name="Page-1" id="b520641d-4fe3-3701-9064-5fc419738815">7VnbctowEP0aHtOxLezAYyGXPqQzmdLp5VFYi62JLFFZBMjXd2VLYGNImJQmeYAwGe/R6rbnrLRAj4yL1a2m8/yrYiB6UcBWPXLVi6LhIMT/FljXQEyCGsg0ZzXUACb8CWow9OiCMygdVkNGKWH4vA2mSkpITQujWqtl222mBGsBc5pBaxkWmKRUQMftJ2cmd2gYNNy/AM9yN/Ugdg1Tmj5kWi2km08qCXVLQf0wzrXMKVPLBkSue2SslTL1U7Eag7BRbUfs5kDrZskapDmmQxQCHSbDKIkpC8JkcJHUIzxSsXBh4HK+MAhp+LOA0rh1m7UPU7nkhaC4QzLKTSEQDPFxpqSZOKcA7TTngt3RtVrYdZUGQ+StUa40f0J/6jtjszZOEFFiR+NCjJVQupqSQGD/Wj0ndkQ3l4YS+977IIQb6I6Wxq9HCUHnJZ9WK7QuBdUZlyNljCqck9/aTXv6WfXCdip4JhFLcSLQdhpLOjC/DU9uPWHBU/cs6BTEaKMSP3SlE7t7rR6gMV9QvTYtXow+zDe04MLm2A/QjErqo1/HL4ycvW/Arlycgh5BG1g1ICefW1AFGL1GF9/q08FledQntb1s5EzifPJGuoTBpctVl6fZZuytYPHBafZI/V529DuTtMDHz1X65Yx3BIwbNW3xthlwtDQ16Jma05TL7A5mdk/9LfLNbdNCy5wbmCBup1viSYmYwvjORKWNnDMGstKOoYZONxkzV1yaKjTxCN8YwXHwKe7FuOQx2uHWxrd110ixxKVTXpEJKPalTdh9NB/M+5d59zwnx9Hs/U7K8qDDstiy/JBT+UTPRJ+I6Dh6R6KHHaKLmuQhuSRJFJCYnGk+Cc2Xg3ekOex3eP6uqZwpXeC9+sYVB1Z455LjI5ccZLBbchx5RIX+o8Vpxdu9jTBpZVmpl9kPQHgOnMvms4abGk76OxomezQ8eDsNdy/aGdeluTgXz0dctpsT4J+q531s/5fb1n/50CB7UYLeofpcRp+W8n119JtRHocdygs15cIRfi6nT073vnr6zegmYYdGYBn4ysLx06D0pasVCwt7m/sLvlFoDNAGyVxrWFuNtiOvWlhx88sPgM+/7VTIX21drdzMlbH2hsQ4/WoajV7W3HarLN/v4PVdqoVO4ZAE3GcU3HsGh3Tij1Yb7WdVokFQwx/bXzXv04Drem/l3igfknb5QOKdqqBepeu1o6TNMl4pruRZcWGi5SpTkorrLfqhtPY6/pMj6PcaOR39B44ANLc/EtSkbn+DIdd/AQ==</diagram></mxfile>