Skip to content
This repository was archived by the owner on Jan 5, 2019. It is now read-only.

Commit 1d003c8

Browse files
authored
Update readme
1 parent 0ad77de commit 1d003c8

1 file changed

Lines changed: 13 additions & 3 deletions

File tree

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,10 @@ It can then be used to get rants and collabs from the feed or by searching.
2727
```
2828
List<Rant> rants = devRant.getRants(Sort.ALGO, 10, 0);
2929
List<Rant> wtf = devRant.search("wtf");
30-
List<Rant> weekly = devRant.getWeekly();
30+
List<Rant> weekly = devRant.getWeekly(Sort.TOP(Range.ALL), 20, 0);
31+
List<Rant> stories = devRant.getStories(Sort.RECENT, 20, 0);
3132
32-
List<Collab> collabs = devRant.getCollabs();
33+
List<Collab> collabs = devRant.getCollabs(10, 0);
3334
3435
Rant random = devRant.getSurprise();
3536
```
@@ -58,7 +59,7 @@ devRant.login("username", "password".toCharArray());
5859
Voting on rants and comments can be done by passing the `Rant` or `Comment` object to vote on, or by directly passing the id.
5960

6061
```
61-
devRant.vote(rant, Vote.DOWN);
62+
devRant.vote(rant, Vote.DOWN(Reason.NOT_FOR_ME));
6263
devRant.vote(comment, Vote.NONE);
6364
6465
devRant.voteRant(429863, Vote.UP);
@@ -89,6 +90,7 @@ This is the base class for rants and comments, which have the following attribut
8990
- upvotes
9091
- downvotes
9192
- score
93+
- voteState
9294
- content
9395
- image
9496

@@ -136,6 +138,14 @@ Alternatively you can fetch the data by calling `fetchData()`, or `fetchData(for
136138
These are the different sort options, which are used when getting rants from the feed.
137139
You can pick between `ALGO`, `RECENT` or `TOP`.
138140

141+
### Range
142+
The range is used for the `TOP` sorting method.
143+
The ranges are `DAY`, `WEEK`, `MONTH`, and `ALL`.
144+
139145
### Vote
140146
These are the different vote options, which are used to vote on rants and comments.
141147
The vote options are `UP`, `NONE` and `DOWN`.
148+
149+
### Reason
150+
These are the reasons for a downvote.
151+
The options are `NOT_FOR_ME`, `REPOST` and `OFFENSIVE_SPAM`.

0 commit comments

Comments
 (0)