Create README.md, populate content with help and guides

Author: socheatsok78

README.md

@@ -0,0 +1,81 @@
+# Laravel Repository Design Pattern
+
+## Contents
+
+- [What is the Repository Design Pattern?](#what-is-the-repository-design-pattern)
+- [Usage](#usage)
+
+## What is the Repository Design Pattern
+
+![Repository Design Pattern](assets/repository_pattern.png)
+
+To put it simply, it is an implementation of a brokering layer between the application and a data source. Neither party needs to be be aware of the other to perform their respective jobs which allows us to have a decoupled architecture which in turn helps in the scaling of the application in the big leagues without having hard dependencies.
+
+## Is it the magic bullet
+
+Well, no it is not. Like every design pattern it has its ups and downs, pros and cons.
+
+### Pros:
+
+- Separation of concerns; the application need not know about or track any or all data sources.
+- Allows easy unit testing as the repositories are bound to interfaces which are injected into classes at run time.
+- DRY (Dont Repeat Yourself) design, the code to query and fetch data from data source(s) is not repeated.
+
+### Cons:
+
+- Adds another layer of abstraction which adds a certain level of complexity making it an overkill for small applications.
+
+## Source
+
+- [Repository Design Pattern Demystified](https://www.sitepoint.com/repository-design-pattern-demystified/)
+- [Use the Repository Design pattern in a Laravel application](https://medium.com/employbl/use-the-repository-design-pattern-in-a-laravel-application-13f0b46a3dce)
+
+# Usage
+
+This package provide a command-line interface for you to create repository in your **Laravel** application.
+
+## Installation
+
+Require `pp-spaces/laravel-repository` package to your laravel installation
+
+```sh
+composer require pp-spaces/laravel-repository
+```
+
+## Make a repository
+
+Run the following command to generate repository:
+
+```sh
+php artisan make:repository UserRepository
+```
+
+To make model repository simply run:
+
+```sh
+php artisan make:repository UserRepository --model=User
+```
+
+## Help
+
+```
+Description:
+  Create a new repository class
+
+Usage:
+  make:repository [options] [--] <name>
+
+Arguments:
+  name                  The name of the class
+
+Options:
+  -m, --model[=MODEL]   Generate a repository for the given model.
+  -h, --help            Display this help message
+  -q, --quiet           Do not output any message
+  -V, --version         Display this application version
+      --ansi            Force ANSI output
+      --no-ansi         Disable ANSI output
+  -n, --no-interaction  Do not ask any interactive question
+      --env[=ENV]       The environment the command should run under
+  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
+```