From 87155dd4b37234628aebc41fcce123da439b5566 Mon Sep 17 00:00:00 2001 From: Matt Lyon Date: Wed, 25 Dec 2019 17:57:37 +0000 Subject: updated README, added some comments --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index eb64e08..22e725f 100644 --- a/README.md +++ b/README.md @@ -48,11 +48,23 @@ torrent = torrents[3] print(torrent.magnetlink) ``` ## Browse -Alternatively you can browse all of the torrents from a single category. ```python +# You can browse all of the torrents from a single category +torrents = t.browse(category=CATEGORIES.VIDEOS) +# Customize the page number and sort order torrents = t.browse(category=CATEGORIES.VIDEO.MOVIES, page=1, order=ORDERS.UPLOADED.DES) ``` +## Categories and Sort Order +```python +# To print all available categories, use the classmethod printOptions +CATEGORIES.printOptions() +# Or just a subset of categories, like VIDEOS +CATEGORIES.VIDEO.printOptions() +# Similarly for the sort order +ORDERS.printOptions() +``` + ## Torrents object The search function returns a `Torrents` object, which is a *list-like* collection of the torrents found. -- cgit v1.2.3