Skip to content
This repository was archived by the owner on Aug 12, 2022. It is now read-only.

Commit f1b5d9f

Browse files
author
Marian ANDRE
committed
[UPD] Update README.md
1 parent e233c19 commit f1b5d9f

File tree

1 file changed

+27
-15
lines changed

1 file changed

+27
-15
lines changed

README.md

+27-15
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,61 @@
1-
# Recast.AI - SDK PHP
2-
3-
[logo]: https://github.com/RecastAI/SDK-PHP/blob/develop/misc/logo-inline.png "Recast.AI"
1+
[logo]: https://cdn.recast.ai/brand/recast-ai-logo-inline.png "Recast.AI"
42

53
![alt text][logo]
64

5+
# Recast.AI - SDK PHP
76
Recast.AI official SDK in PHP
87

98
## Synospis
109

1110
This module is a wrapper around the [Recast.AI](https://recast.ai) API, and allows you to:
12-
* [build a bot](https://github.com/RecastAI/SDK-PHP/wiki/Build-your-bot)
13-
* [analyze your text](https://github.com/RecastAI/SDK-PHP/wiki/Analyse-text)
11+
* [Analyse your text](https://github.com/RecastAI/SDK-PHP/wiki/01---Analyse-text)
12+
* [Manage your conversation](https://github.com/RecastAI/SDK-PHP/wiki/02---Manage-conversation)
13+
* [Receive and send messages](https://github.com/RecastAI/SDK-PHP/wiki/03--Receive-and-send-messages)
14+
1415

1516
## Installation
1617

18+
Install the package using npm, as shown below:
1719
```bash
1820
composer require recastai/sdk-php
1921
```
2022

21-
## Documentation
23+
You can now use the sdk in your code.
2224

23-
You can find the full documentation [here](https://github.com/RecastAI/SDK-PHP/wiki).
25+
Using the entire SDK:
26+
```php
27+
<?php
28+
require_once __DIR__ . '/vendor/autoload.php';
2429

25-
## Specs
30+
use RecastAI\Client;
2631

27-
This module contains 5 classes, as follows:
32+
$client = new Client('YOUR_TOKEN');
33+
```
34+
35+
Extracting one single API:
36+
```php
37+
<?php
38+
require_once __DIR__ . '/vendor/autoload.php';
2839

29-
* [Client](https://github.com/RecastAI/SDK-PHP/wiki/Class-Client) is the client allowing you to make requests.
30-
* [Conversation](https://github.com/RecastAI/SDK-PHP/wiki/Class-Conversation) wraps the response from a call to [Recast.AI](https://recast.ai) API with the textConverse Client method.
31-
* [Response](https://github.com/RecastAI/SDK-PHP/wiki/Class-Response) wraps the response from a call to [Recast.AI](https://recast.ai) API with the textRequest or fileRequest Client methods.
32-
* [Entity](https://github.com/RecastAI/SDK-PHP/wiki/Class-Entity) represents an entity extracted from an input.
40+
use RecastAI\Client;
41+
42+
$request = Client::Request('YOUR_TOKEN');
43+
$connect = Client::Connect('YOUR_TOKEN');
44+
```
3345

3446
## More
3547

3648
You can view the whole API reference at [man.recast.ai](https://man.recast.ai).
3749

3850
## Author
3951

40-
Bruno Gantelmi, bruno.gantelmi@recast.ai
52+
Marian André, marian.andre@recast.ai
4153

4254
You can follow us on Twitter at [@recastai](https://twitter.com/recastai) for updates and releases.
4355

4456
## License
4557

46-
Copyright (c) [2016] [Recast.AI](https://recast.ai)
58+
Copyright (c) [2017] [Recast.AI](https://recast.ai)
4759

4860
Permission is hereby granted, free of charge, to any person obtaining a copy
4961
of this software and associated documentation files (the "Software"), to deal

0 commit comments

Comments
 (0)