diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index fe4cfe6..ba1d93a 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -44,7 +44,7 @@ body: attributes: label: Laravel Version description: What version of Laravel are you running? Please be as specific as possible - placeholder: 9.0.0 + placeholder: 11.0.0 validations: required: true - type: dropdown diff --git a/README.md b/README.md index d38728c..3d411c3 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,8 @@ BayLinks PHP SDK for Laravel framework. +[BayLinks](https://baylinks.io) is a powerful URL shortening and management platform tailored for modern businesses. As a Software as a Service (SaaS) solution, BayLinks empowers organizations to create, customize, and track short links effortlessly. Perfect for marketing campaigns, email newsletters, and internal communications, [BayLinks](https://baylinks.io) simplifies link sharing and enhances brand visibility. With robust analytics and customizable branding options, [BayLinks](https://baylinks.io) is the go-to solution for businesses seeking efficient link management and optimization. + ## Installation You can install the package via composer: @@ -27,14 +29,21 @@ php artisan vendor:publish --tag="baylinks-laravel-config" Update the server information: return [ - 'server' => env('BAYLINKS_SERVER'), // Server domain + /** + * BayLinks URL. + */ + 'server' => env('BAYLINKS_SERVER'), + + /** + * Rest API version of BayLinks. + */ 'api' => [ - 'url' => 'api/v1', // API Version + 'url' => 'api/v1', ], ]; - ``` + ```php Get the account Information: @@ -42,18 +51,19 @@ $bayLinks = BayLinks::client(); $bayLinks->accountDetails()->get(); ``` + ```php Create a Single Short URL: $bayLinks->createShortURL() ->post(, [ - "destination" => "", // required - "domain" => "" // optional + "destination" => "", // required + "domain" => "" // optional ] ); - ``` + ```php Create a Bulk Short URL: @@ -73,10 +83,8 @@ $bayLinks->createBulkURL() "tag": [] // optional callback data ] ); - ``` - ## Testing ```bash diff --git a/composer.json b/composer.json index 9642eca..c12827e 100644 --- a/composer.json +++ b/composer.json @@ -23,7 +23,7 @@ "require": { "php": "^8.2", "illuminate/contracts": "^10.0 | ^11.0", - "sammyjo20/saloon": "^2.8", + "saloonphp/saloon": "^3.0", "spatie/laravel-package-tools": "^1.14.0" }, "require-dev": {