Merge pull request #1 from codebar-ag/feature-v1

Feature V1

Author: StanBarrows

.github/workflows/run-tests.yml

@@ -14,13 +14,13 @@ jobs:
       matrix:
         # os: [ ubuntu-latest, windows-latest ]
         os: [ ubuntu-latest ]
-        php: [ 8.1 ]
-        laravel: [ 9.* ]
+        php: [ 8.2 ]
+        laravel: [ 10.* ]
         #stability: [ prefer-lowest, prefer-stable ]
         stability: [ prefer-stable ]
         include:
-          - laravel: 9.*
-            testbench: 7.*
+          - laravel: 10.*
+            testbench: 8.*
 
     name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.stability }} - ${{ matrix.os }}
 

README.md

@@ -1,3 +1,31 @@
+<img src="https://banners.beyondco.de/Laravel%20Flatfox.png?theme=light&packageManager=composer+require&packageName=codebar-ag%2Flaravel-flatfox&pattern=circuitBoard&style=style_2&description=A+Laravel+Flatfox+integration+to+receive+public+listings.&md=1&showWatermark=1&fontSize=150px&images=home&widths=500&heights=500">
+
+[![Latest Version on Packagist](https://img.shields.io/packagist/v/codebar-ag/laravel-flatfox.svg?style=flat-square)](https://packagist.org/packages/codebar-ag/laravel-flatfox)
+[![Total Downloads](https://img.shields.io/packagist/dt/codebar-ag/laravel-flatfox.svg?style=flat-square)](https://packagist.org/packages/codebar-ag/laravel-flatfox)
+[![run-tests](https://github.com/codebar-ag/laravel-flatfox/actions/workflows/run-tests.yml/badge.svg)](https://github.com/codebar-ag/laravel-flatfox/actions/workflows/run-tests.yml)
+[![PHPStan](https://github.com/codebar-ag/laravel-flatfox/actions/workflows/phpstan.yml/badge.svg)](https://github.com/codebar-ag/laravel-flatfox/actions/workflows/phpstan.yml)
+[![Check & fix styling](https://github.com/codebar-ag/laravel-flatfox/actions/workflows/php-cs-fixer.yml/badge.svg)](https://github.com/codebar-ag/laravel-flatfox/actions/workflows/php-cs-fixer.yml)
+
+This package was developed to give you a quick start to receive public listings from the Flatfox API.
+
+## 💡 What is Flatfox?
+
+Flatfox is a web based portal whereh you can Search & advertise apartments for free.
+
+## 🛠 Requirements
+
+| Package 	 | PHP 	  | Laravel 	        | Flatfox 	 |
+|-----------|--------|------------------|-----------|
+| >v1.0     | >8.2   | > Laravel 10.0   | ✅         |
+
+## ⚙️ Installation
+
+You can install the package via composer:
+
+```bash
+composer require codebar-ag/laravel-flatfox
+```
+
 ## Usage
 
 ```php
@@ -13,13 +41,6 @@ Copy your own phpunit.xml-file.
 cp phpunit.xml.dist phpunit.xml
 ```
 
-Modify environment variables in the phpunit.xml-file:
-
-```xml
-
-<env name="FLATFOX_TOXEN" value="token"/>
-```
-
 Run the tests:
 
 ```bash

composer.json

@@ -22,7 +22,7 @@
         "guzzlehttp/guzzle": "^7.2",
         "illuminate/contracts": "^10.0",
         "sammyjo20/saloon": "^2.6",
-        "sammyjo20/saloon-cache-plugin": "^2.1",
+        "saloonphp/cache-plugin": "^2.1",
         "spatie/laravel-package-tools": "^1.9.2"
     },
     "require-dev": {

src/Response/PublicListing.php

@@ -7,7 +7,7 @@
 use Illuminate\Support\Collection;
 use Saloon\Contracts\Response;
 
-class PublicListing
+final class PublicListing
 {
     public function __construct(
         public int $count,