Skip to content

Commit 9f366c6

Browse files
committed
Merge remote-tracking branch 'origin/master'
2 parents 912859e + d84d6ac commit 9f366c6

File tree

1 file changed

+41
-3
lines changed

1 file changed

+41
-3
lines changed

README.md

Lines changed: 41 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,44 @@
1-
# ripple-api
2-
A PHP API for interacting with the XRP Ledger
1+
<h1 align="center">
2+
Ripple API
3+
<br>
4+
</h1>
5+
<h4 align="center">
6+
A PHP API for interacting with the XRP Ledger
7+
</h4>
8+
9+
10+
## Installation
11+
12+
The preferred method is via composer. Follow the installation instructions if you do not already have composer installed. Once composer is installed, execute the following command in your project root to install this library:
13+
14+
Installation is possible using Composer.
15+
16+
If you don't already use Composer, you can download the composer.phar binary:
17+
18+
```bash
19+
curl -sS https://getcomposer.org/installer | php
20+
```
21+
22+
Then install the library:
23+
24+
```bash
25+
> composer require iexbase/ripple-api
26+
```
27+
28+
Additional examples are available in the [examples](examples/) directory
29+
30+
## Usage
31+
32+
Use the Ripple
33+
34+
```php
35+
$address = "";
36+
$secret_key = "";
37+
38+
$ripple = new \IEXBase\RippleAPI\Ripple($address, $secret_key);
39+
40+
dump($ripple->getAccount());
41+
```
342

443
## Features
544

@@ -8,7 +47,6 @@ A PHP API for interacting with the XRP Ledger
847
+ Sign and submit transactions to the XRP Ledger
948

1049
## More Information
11-
1250
+ [Ripple Developer Center](https://ripple.com/build/)
1351

1452
## Donations

0 commit comments

Comments
 (0)