Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
CodeWithSwastik authored Jun 4, 2021
1 parent c73d2bf commit d17b57d
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,31 @@ print(joke)
await rs.aclose()
```

## Plans
If you've purchased a premium plan you can pass that as a paramater to RandomStuffV3 or RandomStuffV4
```python
plan = "Can be pro/biz/mega/ultra"
rs = RandomStuffV4(api_key = api_key, plan=plan)
```


## Server (V4)
You can specify the server in RandomStuffV4 if you want
```python
server = "Can be primary/backup/unstable"
rs = RandomStuffV4(api_key = api_key, server=server)
```
## Misc
You can also pass `dev_name`, `bot_name` and `ai_language` as paramaters to RandomStuffV3 or RandomStuffV4.

## Functions available

The current list of asynchronous functions available are:

```python
# endpoints
await get_joke(_type = "any") # Refer to https://api.pgamerx.com/endpoints
await get_image(_type = "any") # for all the endpoints
await get_joke(_type) # Refer to https://api.pgamerx.com/endpoints
await get_image(_type) # for all the endpoints
await get_ai_response(msg)

# others
Expand All @@ -62,3 +78,4 @@ await aclose() # closes the object
## Important Links
* Register API key - [Click Here](https://api.pgamerx.com/register)
* Documentation/Endpoints - [Click Here](https://api.pgamerx.com/endpoints/)

0 comments on commit d17b57d

Please sign in to comment.