From 012b75671e11306c78576b66fbf07bedec38c92c Mon Sep 17 00:00:00 2001
From: dev001 <rise4bux@gmail.com>
Date: Thu, 26 Apr 2018 19:30:58 +0530
Subject: [PATCH] Readme updated

---
 README.md | 100 +++++++++++++++++-------------------------------------
 1 file changed, 31 insertions(+), 69 deletions(-)

diff --git a/README.md b/README.md
index f202115..f4e6e92 100644
--- a/README.md
+++ b/README.md
@@ -1,87 +1,49 @@
-# Project Title
+# Communicator
 
-One Paragraph of project description goes here
+Send email & sms
 
-## Getting Started
+# Requirements
 
-These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
-
-### Prerequisites
-
-What things you need to install the software and how to install them
+* Php
+* Curl
 
+# Installation
+Require this package with composer
 ```
-Give examples
+composer require ruchirkakkad/communicator
 ```
 
-### Installing
-
-A step by step series of examples that tell you have to get a development env running
-
-Say what the step will be
-
-```
-Give the example
+Add service provider to your app/config.php providers array
+```php
+Picahoo\Communicator\CommunicatorServiceProvider::class,
 ```
 
-And repeat
-
+Add Alias to your aliases array in your app/config.php
+```php
+'Communicator' => Picahoo\Communicator\Facades\Communicator::class,
 ```
-until finished
+Publish config with
 ```
-
-End with an example of getting some data out of the system or using it for a little demo
-
-## Running the tests
-
-Explain how to run the automated tests for this system
-
-### Break down into end to end tests
-
-Explain what these tests test and why
-
+php artisan vendor:publish --provider="Picahoo\Communicator\CommunicatorServiceProvider"
 ```
-Give an example
+# How to use 
+load Communicator class in your file
+ ```
+use Communicator;
+   ```
+   or
+   ```
+  use Picahoo\Communicator\Facades\Communicator;
+  ```
+  
+# Send email 
+```
+    Communicator::sendEmail('Email address', 'Message..', 'Subject here..');    
 ```
 
-### And coding style tests
-
-Explain what these tests test and why
 
+# Send sms 
 ```
-Give an example
+    Communicator::sendSms(['email' => 'Email address','phone' => 'phone number'], 'Message..');    
 ```
 
-## Deployment
-
-Add additional notes about how to deploy this on a live system
-
-## Built With
-
-* [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used
-* [Maven](https://maven.apache.org/) - Dependency Management
-* [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds
-
-## Contributing
-
-Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
-
-## Versioning
-
-We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags). 
-
-## Authors
-
-* **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth)
-
-See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.
-
-## License
-
-This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
-
-## Acknowledgments
-
-* Hat tip to anyone who's code was used
-* Inspiration
-* etc