New readme

JBZoo · Apr 13, 2021 · 5d61aca · 5d61aca
1 parent 6506bff
commit 5d61aca
Show file tree

Hide file tree

Showing 9 changed files with 112 additions and 492 deletions.
diff --git a/README.md b/README.md
@@ -1,25 +1,48 @@
 # JBZoo / Mock-Server
 
-[![Build Status](https://travis-ci.org/JBZoo/Mock-Server.svg)](https://travis-ci.org/JBZoo/Mock-Server)    [![Coverage Status](https://coveralls.io/repos/JBZoo/Mock-Server/badge.svg)](https://coveralls.io/github/JBZoo/Mock-Server)    [![Psalm Coverage](https://shepherd.dev/github/JBZoo/Mock-Server/coverage.svg)](https://shepherd.dev/github/JBZoo/Mock-Server)    
-[![Stable Version](https://poser.pugx.org/jbzoo/mock-server/version)](https://packagist.org/packages/jbzoo/mock-server)    [![Latest Unstable Version](https://poser.pugx.org/jbzoo/mock-server/v/unstable)](https://packagist.org/packages/jbzoo/mock-server)    [![Dependents](https://poser.pugx.org/jbzoo/mock-server/dependents)](https://packagist.org/packages/jbzoo/mock-server/dependents?order_by=downloads)    [![GitHub Issues](https://img.shields.io/github/issues/jbzoo/mock-server)](https://github.com/JBZoo/Mock-Server/issues)    [![Total Downloads](https://poser.pugx.org/jbzoo/mock-server/downloads)](https://packagist.org/packages/jbzoo/mock-server/stats)    [![GitHub License](https://img.shields.io/github/license/jbzoo/mock-server)](https://github.com/JBZoo/Mock-Server/blob/master/LICENSE)
+[![Build Status](https://travis-ci.org/JBZoo/Mock-Server.svg)](https://travis-ci.org/JBZoo/Mock-Server)    [![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/jbzoo/mock-server.svg)](https://hub.docker.com/r/jbzoo/mock-server)    [![Coverage Status](https://coveralls.io/repos/JBZoo/Mock-Server/badge.svg)](https://coveralls.io/github/JBZoo/Mock-Server)    [![Psalm Coverage](https://shepherd.dev/github/JBZoo/Mock-Server/coverage.svg)](https://shepherd.dev/github/JBZoo/Mock-Server)    [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/jbzoo/mock-server/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/jbzoo/mock-server/?branch=master)    [![CodeFactor](https://www.codefactor.io/repository/github/jbzoo/mock-server/badge)](https://www.codefactor.io/repository/github/jbzoo/mock-server/issues)    [![PHP Strict Types](https://img.shields.io/badge/strict__types-%3D1-brightgreen)](https://www.php.net/manual/en/language.types.declarations.php#language.types.declarations.strict)    
+[![Stable Version](https://poser.pugx.org/jbzoo/mock-server/version)](https://packagist.org/packages/jbzoo/mock-server)    [![Dependents](https://poser.pugx.org/jbzoo/mock-server/dependents)](https://packagist.org/packages/jbzoo/mock-server/dependents?order_by=downloads)    [![GitHub Issues](https://img.shields.io/github/issues/jbzoo/mock-server)](https://github.com/JBZoo/Mock-Server/issues)    [![Total Downloads](https://poser.pugx.org/jbzoo/mock-server/downloads)](https://packagist.org/packages/jbzoo/mock-server/stats)    [![Docker Pulls](https://img.shields.io/docker/pulls/jbzoo/mock-server.svg)](https://hub.docker.com/r/jbzoo/mock-server)    [![GitHub License](https://img.shields.io/github/license/jbzoo/mock-server)](https://github.com/JBZoo/Mock-Server/blob/master/LICENSE)
 
 
 
 ### Installing
 
 ```sh
+# Build it into you project
 composer require jbzoo/mock-server
+
+# OR use phar file. Replace <VERSION> to the last version. See releases page
+wget https://github.com/JBZoo/Mock-Server/releases/download/<VERSION>/mock-server.phar 
+
+# OR just pul docker image
+docker pull jbzoo/mock-server:latest
 ```
 
 
 ### Usage
 
-```php
-use JBZoo\SkeletonPhp\Mock-Server;
+```shell
+# Mock-Server is built-in into your project
+php `pwd`/jbzoo-mock-server    \
+        --host=0.0.0.0         \
+        --port=8089            \
+        --host-tls=localhost   \
+        --port-tls=8090        \
+        --mocks=./mocks        \
+        --ansi                 \
+        -vvv
+
+# Or Docker image
+docker run                       \
+    --rm                         \
+    --name="mock-server"         \
+    -v `pwd`/tests/mocks:/mocks  \
+    -p 8089:8089                 \
+    -p 8090:8090                 \
+    jbzoo/mock-server:latest     \
+    --ansi                       \
+    -vvv
 
-// Just use it!
-$object = new Mock-Server();
-$object->doSomeStreetMagic(':)');
 ```
 
 

diff --git a/composer.json b/composer.json
@@ -39,7 +39,7 @@
 
     "require-dev"       : {
         "jbzoo/http-client" : "^3.4.2",
-        "jbzoo/toolbox-dev" : "^2.8.0",
+        "jbzoo/toolbox-dev" : "^2.9.0",
         "guzzlehttp/guzzle" : "^7.3.0"
     },
 

diff --git a/composer.lock b/composer.lock
diff --git a/tests/MockServerReadmeTest.php b/tests/MockServerReadmeTest.php
@@ -28,4 +28,40 @@ class MockServerReadmeTest extends AbstractReadmeTest
      * @var string
      */
     protected $packageName = 'Mock-Server';
+
+    /**
+     * @var string[]
+     */
+    protected $badgesTemplate = [
+        'travis',
+        'docker_build',
+        'coveralls',
+        'psalm_coverage',
+        'scrutinizer',
+        'codefactor',
+        'strict_types',
+        '__BR__',
+        'latest_stable_version',
+        'dependents',
+        'github_issues',
+        'total_downloads',
+        'docker_pulls',
+        'github_license',
+    ];
+
+    /**
+     * @inheritDoc
+     */
+    protected function setUp(): void
+    {
+        $this->params = array_merge($this->params, [
+            'docker_build' => true,
+            'docker_pulls' => true,
+            'scrutinizer'  => true,
+            'codefactor'   => true,
+            'strict_types' => true,
+        ]);
+
+        parent::setUp();
+    }
 }