update docs

Author: mhdcodes

docs/index.md

@@ -1,37 +1,93 @@
-## Welcome to GitHub Pages
+# Pest plugin for PHP-VCR
 
-You can use the [editor on GitHub](https://github.com/phpjuice/pest-plugin-vcr/edit/main/docs/index.md) to maintain and preview the content for your website in Markdown files.
+![GitHub Actions](https://github.com/phpjuice/pest-plugin-vcr/actions/workflows/ci.yml/badge.svg)
+[![Latest Stable Version](http://poser.pugx.org/phpjuice/pest-plugin-vcr/v)](https://packagist.org/packages/phpjuice/pest-plugin-vcr)
+[![Total Downloads](http://poser.pugx.org/phpjuice/pest-plugin-vcr/downloads)](https://packagist.org/packages/phpjuice/pest-plugin-vcr)
+[![License](http://poser.pugx.org/phpjuice/pest-plugin-vcr/license)](https://packagist.org/packages/phpjuice/pest-plugin-vcr)
 
-Whenever you commit to this repository, GitHub Pages will run [Jekyll](https://jekyllrb.com/) to rebuild the pages in your site, from the content in your Markdown files.
+Integrates Pest with [PHP-VCR](http://php-vcr.github.io) using plugins.
 
-### Markdown
+## Installation
 
-Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for
+You can install the package via composer:
 
-```markdown
-Syntax highlighted code block
+```bash
+composer require phpjuice/pest-plugin-vcr --dev
+```
+
+## Setup
 
-# Header 1
-## Header 2
-### Header 3
+Add new folder inside tests to store cassettes:
+
+```bash
+mkdir tests/cassettes
+```
 
-- Bulleted
-- List
+Add the following line to your `Pest.php` file, inorder to instruct
+php vcr of our cassettes folder:
 
-1. Numbered
-2. List
+```php
+use VCR\VCR;
 
-**Bold** and _Italic_ and `Code` text
 
-[Link](url) and ![Image](src)
+VCR::configure()->setCassettePath(__DIR__.'/cassettes');
 ```
 
-For more details see [GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/).
+## Usage
+
+This plugin will provide you with two handy functions `vcrTurnOn` & `vcrTurnOff` to turn on and off the http recording :
+
+```php
+it('records requests to pestphp.com', function () {
+
+    vcrTurnOn('pestphp.com');
+
+    $result = file_get_contents('https://pestphp.com/');
+
+    expect($result)
+        ->toBe('Hello from pestphp.');
+
+    vcrTurnOff();
+});
+```
+
+The previous testsuite, will first send a request to `pestphp.com` and
+Record your test suite's HTTP interactions into a cassette and replay them
+during future test runs for fast, deterministic, accurate tests.
+
+> **Important** before running your tests make sure to have the following folder `tests/cassettes`
+
+### Testing
+
+```bash
+composer test
+```
+
+### Changelog
+
+Please see [CHANGELOG](../CHANGELOG.md) for more information what has changed recently.
+
+## Contributing
+
+Please see [CONTRIBUTING](../CONTRIBUTING.md) for details.
+
+### Security
+
+If you discover any security related issues, reach out to me @tsd_mohammed instead of using the issue tracker.
+
+## Credits
+
+- [All Contributors](../../../contributors)
+
+## License
 
-### Jekyll Themes
+The MIT License (MIT). Please see [License File](../LICENSE.md) for more information.
 
-Your Pages site will use the layout and styles from the Jekyll theme you have selected in your [repository settings](https://github.com/phpjuice/pest-plugin-vcr/settings/pages). The name of this theme is saved in the Jekyll `_config.yml` configuration file.
+## PHP Package Boilerplate
 
-### Support or Contact
+This package was generated using the [PHP Package Boilerplate](https://laravelpackageboilerplate.com) by [Beyond Code](http://beyondco.de/).
 
-Having trouble with Pages? Check out our [documentation](https://docs.github.com/categories/github-pages-basics/) or [contact support](https://support.github.com/contact) and we’ll help you sort it out.
+![GitHub Actions](https://github.com/phpjuice/pest-plugin-vcr/actions/workflows/ci.yml/badge.svg)
+[![Latest Stable Version](http://poser.pugx.org/phpjuice/pest-plugin-vcr/v)](https://packagist.org/packages/phpjuice/pest-plugin-vcr)
+[![Total Downloads](http://poser.pugx.org/phpjuice/pest-plugin-vcr/downloads)](https://packagist.org/packages/phpjuice/pest-plugin-vcr)
+[![License](http://poser.pugx.org/phpjuice/pest-plugin-vcr/license)](https://packagist.org/packages/phpjuice/pest-plugin-vcr)