Skip to content

Commit 628aaa0

Browse files
committed
instructions
1 parent 2bf5a8b commit 628aaa0

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

README.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Thepeer Laravel SDK
2+
3+
## Installation
4+
5+
```bash
6+
composer install thepeer/sdk
7+
```
8+
9+
## Usage
10+
11+
### Initiate
12+
13+
```php
14+
<?php
15+
16+
$thepeer = new \Thepeer\Sdk\Thepeer("your-secret-key");
17+
```
18+
19+
### Available methods
20+
21+
* validateSiganture
22+
- `accepts`:
23+
- request object
24+
- `returns`: boolean
25+
26+
* getReceipt
27+
- `accepts`:
28+
- reference
29+
- `returns`: object
30+
31+
* processReceipt
32+
- `accepts`:
33+
- reference (string)
34+
- `returns`: object
35+
36+
* indexUser
37+
- `accepts`:
38+
- name (string)
39+
- email (string)
40+
- identifier (string)
41+
- `returns`: object
42+
43+
* updateUser
44+
- `accepts`:
45+
- reference (string)
46+
- identifier (string)
47+
- `returns`: object
48+
49+
* deleteUser
50+
- `accepts`:
51+
- reference (string)
52+
- `returns`: boolean
53+
54+
## Extra
55+
56+
Refer to the [documentation](https://documenter.getpostman.com/view/2370026/TzJu8wdy) for more information.

0 commit comments

Comments
 (0)