Skip to content

Commit c5ac1f4

Browse files
Add Slack documentation about token in the doc, cf #88
1 parent 3618cae commit c5ac1f4

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

doc/index.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This library mostly contains automatically generated code from the official
66
[Slack OpenAPI spec](https://github.com/slackapi/slack-api-specs).
77

88
The library provides three kinds of PHP classes:
9-
- [endpoints](../generated/Endpoint/) represent requests to API methods
9+
- [endpoints](../generated/Endpoint) represent requests to API methods
1010
- [models](../generated/Model) represent data from the API
1111
- [normalizers](../generated/Normalizer) transform JSON from the API to PHP models
1212

@@ -28,7 +28,7 @@ use JoliCode\Slack\ClientFactory;
2828
$client = ClientFactory::create($yourToken);
2929
```
3030

31-
The client contains all the methods to communicate with Slack'API. Checkout its
31+
The client contains all the methods to communicate with Slack API. Checkout its
3232
PHP doc to know which option you can provide to each method:
3333

3434
```php
@@ -38,16 +38,18 @@ PHP doc to know which option you can provide to each method:
3838
$members = $client->usersList(['limit' => 100])->getMembers();
3939
```
4040

41+
> 💡 If you need a Slack Token, please follow the instructions at https://api.slack.com/authentication/basics
42+
4143
## Concrete examples
4244

43-
Here is some examples of library's usages:
45+
Here are some examples of library's usages:
4446

4547
- [Posting a message in a Slack channel](examples/posting-message.php);
4648
- [Retrieving the users in a Slack workspace](examples/retrieve-users.php);
4749

4850
## Bypassing the incomplete API specification
4951

50-
Slack's OpenAPI spec is not 100% complete yet hence our generated client may
52+
Slack's OpenAPI spec is not 100% complete yet, hence our generated client may
5153
miss some features.
5254

5355
If you miss an option in a method, until Slack add it to their spec, we can
@@ -57,7 +59,7 @@ manually add it to our [versioned spec](../resources/slack-openapi.json) then
5759
If you miss a property in a model, you may still access it by yourself. Some
5860
models extend the `ArrayObject` so you can access all its properties with the
5961
array notation. For example - until mid-2019 - the `usergroupsList` response
60-
did not contain the `usergroups` property but we could access it this way:
62+
did not contain the `usergroups` property, but we could access it this way:
6163

6264
```php
6365
$userGroupsResponse = $client->usergroupsList();

0 commit comments

Comments
 (0)