Skip to content

Commit a0834ae

Browse files
committed
Update readme.
1 parent 861b643 commit a0834ae

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -133,8 +133,8 @@ The returned JSONObject could look like this:
133133
}
134134
```
135135

136-
### Single Botlist
137-
Calling `.getBotList(..., Site|String)` returns a specific Botlist as JSONObject.
136+
### Single Bot list
137+
Calling `.getBotList(String, Site|String)` returns a specific Botlist as JSONObject.
138138
For example does `.getBotList("123456789012345678", "lbots.org")` return the following JSONObject:
139139
```json
140140
{
@@ -148,7 +148,9 @@ For example does `.getBotList("123456789012345678", "lbots.org")` return the fol
148148
}
149149
```
150150

151-
### Complete Botinfo
151+
The first String parameter is used for the internal caching.
152+
153+
### Complete Bot info
152154
Calling `.getAll(...)` returns a JSONObject from all the botlists and with some general information.
153155

154156
The JSONObject can look like this:
@@ -176,9 +178,9 @@ The JSONObject can look like this:
176178
```
177179

178180
`{"data"}` is the JSON that is returned by the provided Botlist meaning it's different for each site.
179-
`name`, `owners`, `server_count` and `invite` is based on the most common appearances of the data.
181+
`name`, `discriminator`, `owners`, `server_count` and `invite` are based on the most common appearances of the data.
180182

181-
### Botinfo from all Botlists
183+
### Bot info from all Bot lists
182184
You can call `.getBotListInfo(...)` to only receive the bot info from all the Botlists.
183185

184186
The returned JSONObject can look like this:
@@ -196,10 +198,18 @@ The returned JSONObject can look like this:
196198
```
197199
`{"data"}` is the JSON that is returned by the provided Botlist meaning it's different for each site.
198200

199-
### Botinfo of a single site
201+
### Bot info of a single site
200202
With `.getBotListInfo(..., Site|String)` can you receive the info of a specific site.
201203
The returned data depends on the selected site and can be different for each one.
202204

205+
### Invite
206+
The method `getInvite(Long|String)` allows you to get the OAuth invite of the bot.
207+
The invite is based on the most common appearance on the different bot lists.
208+
209+
### Server count
210+
`.getServerCount(Long|String)` gives you the server count of the bot.
211+
The server count is based on the most common appearance on the different bot lists.
212+
203213
### Owners
204214
You can call `.getOwners(...)` to get the owners of a Bot from all the Botlists.
205215
The info is returned as ArrayList and is based on how often the info is provided by the botlists.

0 commit comments

Comments
 (0)