Skip to content

Commit

Permalink
updates
Browse files Browse the repository at this point in the history
  • Loading branch information
lewislarsen committed Aug 9, 2024
1 parent 685b988 commit 9940b9d
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 14 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
# VanguardBackup PHP SDK
# Vanguard PHP SDK

## Overview

The VanguardBackup PHP SDK offers a fluent interface for interacting with the VanguardBackup API, enabling efficient management of your backup operations.
The Vanguard PHP SDK offers a fluent interface for interacting with Vanguard's API, enabling efficient management of your backup operations.

## API Documentation

While this SDK provides a convenient way to interact with the VanguardBackup API, you may sometimes need more detailed information about the specific parameters and responses for each endpoint. For comprehensive API documentation, including request/response schemas and example payloads, please refer to our official API documentation:
While this SDK provides a convenient way to interact with Vanguard's API, you may sometimes need more detailed information about the specific parameters and responses for each endpoint. For comprehensive API documentation, including request/response schemas and example payloads, please refer to our official API documentation:

[VanguardBackup API Documentation](https://docs.vanguardbackup.com/api/introduction)
[Vanguard API Documentation](https://docs.vanguardbackup.com/api/introduction)

This resource will be invaluable when constructing requests or handling responses, especially for more complex operations not fully abstracted by the SDK.

## Getting Started

### Installation

Add the VanguardBackup SDK to your project using Composer:
Add the Vanguard PHP SDK to your project using Composer:

```bash
composer require vanguardbackup/vanguard-sdk
Expand All @@ -30,7 +30,7 @@ Create a new instance of the VanguardBackup client:
$vanguard = new VanguardBackup\Vanguard\VanguardClient('YOUR_API_KEY');
```

For custom VanguardBackup installations, specify the API base URL:
For custom Vanguard installations, specify the API base URL:

```php
$vanguard = new VanguardBackup\Vanguard\VanguardClient('YOUR_API_KEY', 'https://your-vanguard-instance.com/api');
Expand All @@ -48,7 +48,7 @@ $user = $vanguard->user();

### Backup Task Management

Backup tasks are central to VanguardBackup operations. Here's how to interact with them:
Backup tasks are central to Vanguard's operations. Here's how to interact with them:

```php
// List all backup tasks
Expand Down
13 changes: 6 additions & 7 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "vanguardbackup/vanguard-php-sdk",
"description": "The official VanguardBackup PHP SDK.",
"description": "The official Vanguard PHP SDK.",
"keywords": ["vanguard", "backup", "sdk", "php"],
"license": "MIT",
"support": {
Expand All @@ -14,17 +14,16 @@
}
],
"require": {
"php": "^7.2|^8.0",
"php": "^7.2|^8.0|^8.1|^8.2|^8.3|^8.4",
"ext-json": "*",
"guzzlehttp/guzzle": "^6.3.1|^7.0"
"guzzlehttp/guzzle": "^7.0"
},
"require-dev": {
"roave/security-advisories": "dev-latest"
,
"roave/security-advisories": "dev-latest",
"illuminate/support": "^7.0|^8.0|^9.0|^10.0|^11.0",
"mockery/mockery": "^1.3.1",
"phpstan/phpstan": "^1.10",
"phpunit/phpunit": "^8.4|^9.0|^10.4"
"phpunit/phpunit": "^8.5|^9.0|^10.0"
},
"autoload": {
"psr-4": {
Expand All @@ -38,7 +37,7 @@
},
"extra": {
"branch-alias": {
"dev-master": "1.x-dev"
"dev-main": "0.x-dev"
},
"laravel": {
"providers": [
Expand Down

0 comments on commit 9940b9d

Please sign in to comment.