aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMatt Lyon <matthewlyon18@gmail.com>2019-12-25 17:57:37 +0000
committerMatt Lyon <matthewlyon18@gmail.com>2019-12-25 17:57:37 +0000
commit87155dd4b37234628aebc41fcce123da439b5566 (patch)
tree3506598f3acb1901f4bfbfe499f29129593d8e8f /README.md
parentba5437c656c479c36a7eb460d0b521898c11d0f6 (diff)
downloadtpb-lite-87155dd4b37234628aebc41fcce123da439b5566.tar.gz
tpb-lite-87155dd4b37234628aebc41fcce123da439b5566.tar.bz2
tpb-lite-87155dd4b37234628aebc41fcce123da439b5566.zip
updated README, added some commentsv.0.3.0
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 13 insertions, 1 deletions
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.