Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
firstaidguyheru authored Apr 12, 2021
1 parent ae6f55d commit 5694874
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions Docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Usage of search function:
```python
import cocktaildb

async def tequila_info():
return await cocktaildb.search(query='tequila')
```
Parameters include query, id, key, category, dict: bool, first_letter_only: bool, ingredient: bool, random: bool.
All of which default to either None or False.

Lists of categories, ingredients etc. that may appear:
```
import cocktaildb
# This is in literally a list, not in the form of a dict or string
async def list_of_categories():
return await cocktaildb.categories()
```
There are more functions such as glasses() and ingredients().

This is a simple api wrapper that only supports free endpoints (for now atleast).

0 comments on commit 5694874

Please sign in to comment.