feat: update README.md

Author: lichtner

.github/ISSUE_TEMPLATE/config.yml

@@ -6,6 +6,3 @@ contact_links:
   - name: Request a feature
     url: https://github.com/lichtner/laravel-mock-api/discussions/new?category=ideas
     about: Share ideas for new features
-  - name: Report a security issue
-    url: https://github.com/lichtner/laravel-mock-api/security/policy
-    about: Learn how to notify us for sensitive bugs

README.md

@@ -1,20 +1,17 @@
-# Easy and smart mocking external APIs to simplify development
+# Laravel MockApi
+
+*Easy to use, but the powerful micro library for mocking external API*
 
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/lichtner/laravel-mock-api.svg?style=flat-square)](https://packagist.org/packages/lichtner/laravel-mock-api)
 [![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/lichtner/laravel-mock-api/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/lichtner/laravel-mock-api/actions?query=workflow%3Arun-tests+branch%3Amain)
 [![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/lichtner/laravel-mock-api/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/lichtner/laravel-mock-api/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
 [![Total Downloads](https://img.shields.io/packagist/dt/lichtner/laravel-mock-api.svg?style=flat-square)](https://packagist.org/packages/lichtner/laravel-mock-api)
 
-This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
-
-## Support us
-
-[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/laravel-mock-api.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/laravel-mock-api)
+## Why?
 
-We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
-
-We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
+Are you using external APIs and web services during development that are also in the development process? Are they unstable, slow, sometimes returning incorrect results, or unexpectedly unavailable? Are they causing you difficulties? Me too! That was the reason why I created MockApi.
 
+MockApi solves these problems for you. It saves all GET requests from your external web services, and when they are unavailable, it returns saved data as if it were a real API. You no longer have to worry about it.
 ## Installation
 
 You can install the package via composer:
@@ -23,39 +20,110 @@ You can install the package via composer:
 composer require lichtner/laravel-mock-api
 ```
 
-You can publish and run the migrations with:
+Now you can publish config and run the migrations with:
 
 ```bash
-php artisan vendor:publish --tag="laravel-mock-api-migrations"
-php artisan migrate
+php artisan mock-api:install
 ```
 
-You can publish the config file with:
+## Setup
 
-```bash
-php artisan vendor:publish --tag="laravel-mock-api-config"
-```
+Make simple class which wrap all your `Http::get()` request. Create file e.g.: 
 
-This is the contents of the published config file:
+`app/HttpMock.php`
 
 ```php
-return [
-];
+<?php
+
+namespace App;
+
+use Illuminate\Http\Client\Response;
+use Illuminate\Support\Facades\Http;
+use Lichtner\MockApi\MockApi;
+
+class HttpMock
+{
+    public static function get($url): Response
+    {
+        MockApi::use($url);
+
+        $response = Http::get($url);
+
+        MockApi::log($url, $response);
+
+        return $response;
+    }
+}
 ```
 
-Optionally, you can publish the views using
+Now everywhere in your code where you call:
 
-```bash
-php artisan vendor:publish --tag="laravel-mock-api-views"
+```php
+Http::get($url);
 ```
 
-## Usage
+replace it with: 
 
 ```php
-$mockApi = new Lichtner\MockApi();
-echo $mockApi->echoPhrase('Hello, Lichtner!');
+HttpMock::get($url);
 ```
 
+It is done! Now you can start mocking all your external API (and maybe colleagues who are developing them ;-)
+
+## Security 
+
+**Don't worry MockApi is used only on `local` environment! It has no effect on other ones!**
+
+## Mocking management
+
+After you did the changes described in [Setup](#setup) all HTTP GET request will be saved in MockApi tables. But they will not be used. 
+
+You can manage mocking via environment variables in `.env` file.
+
+### Mock all webservices
+
+When something went wrong and your webservices become unavailable, put in `.env`:
+
+```yaml
+MOCK_API=true
+```
+from that moment all webservices start returning last saved responses. 
+
+After your webservices are back, and you want to get real responses just change it back:
+
+```yaml
+MOCK_API=false
+```
+
+### Mock only some of webservices
+
+In db table `mock_api_url` all rows have in column `use` default value `1`. If you want to mock only 1 or more webservices, set other to `0`. 
+
+### Mock data from the past
+
+By default, MockApi returns last saved responses. But maybe all today's responses are messed up because on the testing server of your webservice was installed code with some bug. But you know yesterday result were fine. So use this:
+
+```yaml
+MOCK_API_DATETIME_IS_LESS_THAN="YYYY-MM-DD HH:mm:ss"
+```
+you get results that are less than given datetime.
+
+### Mock data with different status
+
+Normally you don't need to change that. By default, MockApi returns responses with http code less than 300 (200-299). E.g. if you want to return also redirects use this:
+
+```yaml
+MOCK_API_STATUS_IS_LESS_THAN=310
+```
+
+For more information about configuration check [config/mock-api.php](https://github.com/lichtner/laravel-mock-api/blob/main/config/mock-api.php)
+
+## FAQ
+
+*Why does MockApi manage only GET requests?*
+
+Because simply I don't know how to deal with the others ;-) Imagine app call (e.g. `PUT /users/7`) and now what? Probably you have to find all GET request at least `GET /users/7` and `GET /users` and update them. But information about that user can also be part of other responses e.g. part of the `GET /profile`, or there are many users and users resource is paginated etc. If you have any suggestion how to deal with POST, PUT, PATCH, DELETE requests start [discussion](https://github.com/lichtner/laravel-mock-api/discussions/new?category=ideas). 
+
 ## Testing
 
 ```bash
@@ -66,14 +134,6 @@ composer test
 
 Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
 
-## Contributing
-
-Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
-
-## Security Vulnerabilities
-
-Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
-
 ## Credits
 
 - [Marek Lichtner](https://github.com/lichtner)

composer.json

@@ -1,10 +1,12 @@
 {
     "name": "lichtner/laravel-mock-api",
-    "description": "Easy and smart mocking external APIs to simplify development",
+    "description": "Easy to use, but the powerful micro library for mocking external API",
     "keywords": [
         "lichtner",
         "laravel",
-        "laravel-mock-api"
+        "laravel-mock-api",
+        "mocking",
+        "api"
     ],
     "homepage": "https://github.com/lichtner/laravel-mock-api",
     "license": "MIT",