From 6fd91441e04345e734fac13a304d8f2375723e90 Mon Sep 17 00:00:00 2001
From: Artur Khylskyi <arthur.patriot@gmail.com>
Date: Mon, 14 Nov 2022 17:46:40 +0200
Subject: [PATCH] Add readme

---
 README.md | 88 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 88 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..797a905
--- /dev/null
+++ b/README.md
@@ -0,0 +1,88 @@
+
+# ThePower.io SDK for PHP
+
+Production ready SDK for ThePower.io API
+
+
+## Installation
+
+### Install via composer
+
+```bash
+  composer require arthurpatriot/thepower-sdk
+```
+
+### Create new API Client
+
+```php
+use ThePower\PowerClient;
+
+$client = new PowerClient('{NODE_URL}');
+```
+
+Example, `{NODE_URL}` is `https://power-node.allsteeply.com:1443`.
+    
+## Usage
+
+### Get Status
+
+```php
+$client->status();
+```
+
+### Get Node Status
+
+Get current status of the addressed node
+
+```php
+$client->nodeStatus();
+```
+
+### Get Settings
+
+Get current chain parameters
+
+```php
+$client->settings();
+```
+
+### Get Block Info
+
+Get information about the block without transactions
+
+```php
+$client->blockInfo('{HASH}');
+```
+Where `{HASH}` is hash of the block for which the information is needed.
+
+### Get Block
+
+Get information about the block
+
+```php
+$client->block('{HASH}');
+```
+Where `{HASH}` hash of the block for which the information is needed.
+
+### Where Address
+
+The definition of chain belonging to address.
+
+```php
+$client->where('{ADDRESS}');
+```
+Where `{ADDRESS}` is the address of the wallet in textual or binary representation in hex format.
+
+### Get Address Info
+
+Information about a wallet with a given address.
+
+```php
+$client->address('{ADDRESS}');
+```
+Where `{ADDRESS}` is the address of the wallet in textual or binary representation in hex format.
+## Acknowledgements
+
+ - [ThePower.io API Reference](https://doc.thepower.io/docs/Build/api/api-reference)
+ - [ThePower.io About](https://thepower.io)
+