mirror of
https://github.com/twisterarmy/twister-php.git
synced 2025-08-26 06:21:51 +00:00
update readme
This commit is contained in:
parent
7604ca4942
commit
1a20f3e04a
54
README.md
54
README.md
@ -1,6 +1,6 @@
|
||||
# twister-php
|
||||
|
||||
PHP 8 / Composer Library for Twister P2P
|
||||
PHP 8 / Composer tools for twister P2P JSON-RPC API
|
||||
|
||||
## Install
|
||||
|
||||
@ -10,9 +10,9 @@ PHP 8 / Composer Library for Twister P2P
|
||||
|
||||
### Client
|
||||
|
||||
Twister client communication toolkit
|
||||
Implements JSON-RPC API
|
||||
|
||||
```
|
||||
``` php
|
||||
$client = new \Twisterarmy\Twister\Client('http', 'localhost', 28332, 'user', 'pwd');
|
||||
|
||||
var_dump(
|
||||
@ -26,35 +26,35 @@ var_dump(
|
||||
|
||||
#### Methods
|
||||
|
||||
Currently not documented, please visit src/Client.php for details
|
||||
See the `src/Client.php` source for more details!
|
||||
|
||||
* importWallet
|
||||
* getBlockHash
|
||||
* getBlock
|
||||
* getPosts
|
||||
* getPostK
|
||||
* follow
|
||||
* unFollow
|
||||
* getFollowing
|
||||
* getDHTProfileRevisions
|
||||
* getDHTAvatarRevisions
|
||||
* putDHT
|
||||
* createWalletUser
|
||||
* sendNewUserTransaction
|
||||
* newPostMessage
|
||||
* newRetwistMessage
|
||||
* `importWallet`
|
||||
* `getBlockHash`
|
||||
* `getBlock`
|
||||
* `getPosts`
|
||||
* `getPostK`
|
||||
* `follow`
|
||||
* `unFollow`
|
||||
* `getFollowing`
|
||||
* `getDHTProfileRevisions`
|
||||
* `getDHTAvatarRevisions`
|
||||
* `putDHT`
|
||||
* `createWalletUser`
|
||||
* `sendNewUserTransaction`
|
||||
* `newPostMessage`
|
||||
* `newRetwistMessage`
|
||||
|
||||
### Tools
|
||||
|
||||
#### Atom
|
||||
|
||||
``` php
|
||||
$array = \Twisterarmy\Twister\Tools\Atom::feed('url');
|
||||
```
|
||||
|
||||
#### RSS
|
||||
|
||||
Useful to create twister news bot
|
||||
|
||||
##### Feed
|
||||
|
||||
Read remote URL and convert response to formatted twister messages
|
||||
|
||||
```
|
||||
``` php
|
||||
$array = \Twisterarmy\Twister\Tools\Rss::feed('url');
|
||||
```
|
||||
|
||||
@ -70,7 +70,7 @@ $array = \Twisterarmy\Twister\Tools\Rss::feed('url');
|
||||
|
||||
###### Response
|
||||
|
||||
```
|
||||
``` php
|
||||
[
|
||||
time: int,
|
||||
message: string
|
||||
|
Loading…
x
Reference in New Issue
Block a user