Prepare ci, update project info

Author: n.gnato

.github/workflows/ci.yml

@@ -0,0 +1,56 @@
+name: CI
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  php-tests:
+    strategy:
+      matrix:
+        php:
+          - 7.4
+          - 8.0
+          - 8.1
+          - 8.2
+          - 8.3
+          - 8.4
+        prefer:
+          - lowest
+          - stable
+      fail-fast: false
+
+    name: Test on PHP ${{ matrix.php }} with ${{ matrix.prefer }} composer prefer option
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v3
+
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+
+      - name: Check PHP Version
+        run: php -v
+
+      - name: Xdebug Action
+        uses: MilesChou/docker-xdebug@master
+
+      - name: Cache Composer packages
+        id: composer-cache
+        uses: actions/cache@v3
+        with:
+          path: vendor
+          key: ${{ runner.os }}-php-${{ matrix.php }}-composer-${{ hashFiles('**/composer.json') }}-${{ matrix.prefer }}-
+          restore-keys: |
+            ${{ runner.os }}-php-${{ matrix.php }}-composer-${{ matrix.prefer }}-
+      - name: Install dependencies
+        if: steps.composer-cache.outputs.cache-hit != 'true'
+        run: composer update --prefer-${{ matrix.prefer }} --prefer-dist --no-progress
+
+      - name: Run tests
+        env:
+          XDEBUG_MODE: coverage
+        run: vendor/bin/phpunit

Dockerfile

@@ -13,7 +13,7 @@ RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local
 # Composer requirements end
 
 # Xdebug begin
-RUN pecl install xdebug \
+RUN pecl install xdebug-3.1.6 \
     && docker-php-ext-enable xdebug
 
 # Xdebug end

README.md

@@ -1,3 +1,23 @@
 # Static Http Client
 
 [PSR-18](http://www.php-fig.org/psr/psr-18) implementation for testing. Use static files for mock responses and write requests. 
+
+## Installation 
+
+```shell
+composer require free-elephants/static-http-client --dev
+```
+
+## Usage
+
+```php
+public function test()
+{
+    $stubbedHttpClient = new \FreeElephants\StaticHttpClient\StaticHttpClient(
+        $responseFactory, 
+        new \FreeElephants\StaticHttpClient\PathResolver\HostnameAwareResolver()
+    );
+    
+    $response = $stubbedHttpClient->sendRequest();
+}
+```

composer.json

@@ -11,6 +11,9 @@
         "helmich/phpunit-psr7-assert": "^4.2",
         "nyholm/psr7": "^1.3"
     },
+    "suggest": {
+        "nyholm/psr7": "*"
+    },
     "license": "BSD-3-Clause",
     "authors": [
         {
@@ -31,5 +34,8 @@
                 "tests/FreeElephants/StaticHttpClient"
             ]
         }
+    },
+    "config": {
+        "sort-packages": true
     }
 }