Skip to content

Commit bf362ee

Browse files
Merge pull request #10 from sendbird/docs/update-readme
docs: update readme
2 parents 1cff477 + a561e46 commit bf362ee

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
# [Sendbird PHP Platform SDK](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api)
44

55
[![link to docs](https://img.shields.io/badge/SDK-docs-green)](/docs)
6+
[![packagist](https://img.shields.io/packagist/v/sendbird/sendbird-platform-sdk-php.svg)](https://packagist.org/packages/sendbird/sendbird-platform-sdk-php)
7+
68
This is a SDK written for PHP that makes talking to the [Sendbird Platform API](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api) easier.
79
With this library you can extend your Sendbird integration to include advanced features like message-, and channel automation, user management, create user authentication tokens, and create bots.
810

@@ -32,10 +34,6 @@ try {
3234

3335
```
3436

35-
# ⚠️ Warnings
36-
37-
This package is not currently published. Please see the Local development section for installation instructions.
38-
3937
# ⚒️ Prerequisite
4038

4139
In order to make requests with this SDK you will need you master API token. This can be found through the [Sendbird dashboard](https://dashboard.sendbird.com/). Each app you create in Sendbird has its own master api token. These tokens can be found in Settings > Application > General.
@@ -65,6 +63,11 @@ To install the bindings via [Composer](https://getcomposer.org/), add the follow
6563

6664
Then run `composer install`
6765

66+
Or install via:
67+
```bash
68+
composer require sendbird/sendbird-platform-sdk-php
69+
```
70+
6871
### Manual Installation
6972

7073
1. Clone this repository, run `composer install` in the `sendbird-platform-sdk` directory
@@ -80,10 +83,8 @@ require_once('/path/to/sendbird-platform-sdk/vendor/autoload.php');
8083
| | Documentation |
8184
| ----------- | ----------- |
8285
| Announcement | [docs/Api/AnnouncementApi.md](docs/Api/AnnouncementApi.md)|
83-
| Application | [docs/Api/ApplicationApi.md](docs/Api/ApplicationApi.md) |
8486
| Bot | [docs/Api/BotApi.md](docs/Api/BotApi.md) |
8587
| GroupChannel | [docs/Api/GroupChannelApi.md](docs/Api/GroupChannelApi.md) |
8688
| OpenChannel | [docs/Api/OpenChannelApi.md ](docs/Api/OpenChannelApi.md) |
8789
| Message | [docs/Api/MessageApi.md](docs/Api/MessageApi.md) |
88-
| User | [docs/Api/UserApi.md](docs/Api/UserApi.md) |
89-
| Webhooks | [docs/Api/WebhooksApi.md](docs/Api/WebhooksApi.md) |
90+
| User | [docs/Api/UserApi.md](docs/Api/UserApi.md) |

0 commit comments

Comments
 (0)