Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: rewrite as HTTPlug package #60

Draft
wants to merge 13 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ jobs:
strategy:
matrix:
os: [ubuntu-latest]
php: ['8.0', '8.1']
php: ['8.1']
dependency-version: [prefer-lowest, prefer-stable]

name: PHP ${{ matrix.php }} - ${{ matrix.os }} - ${{ matrix.dependency-version }}
Expand Down
24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,37 @@
[![Total Downloads][ico-downloads]][link-downloads]
[![Buy us a tree][ico-treeware-gifting]][link-treeware-gifting]

An API wrapper for the Arionum cryptocurrency node.
An API wrapper for the Arionum cryptocurrency node

## Requirements

- PHP >= 8.1
- A [PSR-17 implementation](https://packagist.org/providers/psr/http-factory-implementation)
- A [PSR-18 implementation](https://packagist.org/providers/psr/http-client-implementation)

## Install

Via Composer

```shell
composer require owenvoke/arionum-php
composer require owenvoke/arionum-php guzzlehttp/guzzle:^7.5 http-interop/http-factory-guzzle:^1.2
```

We are decoupled from any HTTP messaging client with help by [HTTPlug](https://httplug.io).

## Usage

Please see the [live usage docs](https://arionum-php.netlify.app), or the [docs](docs) directory, for information on using this library.
**Basic usage**

```php
// Include the Composer autoloader
require_once __DIR__ . '/vendor/autoload.php';

$client = new \OwenVoke\Arionum\Client();
$client->node()->version();
```

Please see the [live usage docs](https://arionum-php.netlify.app), or the [docs](./docs) directory, for information on using this library.

## Change log

Expand Down
25 changes: 18 additions & 7 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,28 @@
"description": "An API wrapper for the Arionum cryptocurrency node.",
"license": "MIT",
"require": {
"php": "^8.0",
"php": "^8.1",
"ext-json": "*",
"ext-openssl": "*",
"guzzlehttp/guzzle": "^7.3",
"php-http/client-common": "^2.4",
"php-http/discovery": "^1.14",
"php-http/httplug": "^2.2",
"php-http/multipart-stream-builder": "^1.1",
"psr/http-client-implementation": "^1.0",
"psr/http-factory-implementation": "^1.0",
"psr/http-message": "^1.0",
"stephenhill/base58": "^1.1"
},
"require-dev": {
"guzzlehttp/guzzle": "^7.5",
"guzzlehttp/psr7": "^2.1",
"http-interop/http-factory-guzzle": "^1.2",
"laravel/pint": "^1.2",
"mockery/mockery": "^1.3.1",
"pestphp/pest": "^1.1",
"pestphp/pest": "^1.20",
"php-http/mock-client": "^1.5",
"php-http/vcr-plugin": "^1.2",
"phpstan/phpstan": "^1.8.7",
"symfony/var-dumper": "^5.2"
"symfony/var-dumper": "^5.3.8"
},
"autoload": {
"psr-4": {
Expand All @@ -28,12 +38,13 @@
}
},
"scripts": {
"test:types": "phpstan analyse --ansi --memory-limit=0",
"test:types": "phpstan analyse --ansi --memory-limit=-1",
"test:unit": "pest --colors=always",
"test": [
"@test:types",
"@test:unit"
]
],
"update:snapshots": "pest -d --update-snapshots"
},
"config": {
"sort-packages": true,
Expand Down
3 changes: 0 additions & 3 deletions docs/.gitignore

This file was deleted.

17 changes: 0 additions & 17 deletions docs/.vuepress/config.js

This file was deleted.

22 changes: 0 additions & 22 deletions docs/assets.md

This file was deleted.

145 changes: 0 additions & 145 deletions docs/general.md

This file was deleted.

35 changes: 0 additions & 35 deletions docs/get-started.md

This file was deleted.

10 changes: 0 additions & 10 deletions docs/package.json

This file was deleted.

16 changes: 0 additions & 16 deletions docs/readme.md

This file was deleted.

Loading