Skip to content

Commit 4992ede

Browse files
committed
Document the new --top-tweets option
1 parent 9a0fa5a commit 4992ede

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ If you have Python 3 installed, you can install those modules with `pip install
1717
## Setup
1818

1919
In order to run PapersBot, you need to do the following:
20-
- Inside the code, ajust the [regular expression](https://en.wikipedia.org/wiki/Regular_expression) that selects the papers of interest
2120
- Create a file `credentials.yml` which will contain your Twitter app credentials, with four lines:
2221
```
2322
CONSUMER_KEY: "x1F3s..."
@@ -27,9 +26,15 @@ ACCESS_SECRET: "AdnA..."
2726
```
2827
If you do not know how to get your Twitter credentials, follow [steps #1 and #2 in this tutorial](https://www.digitalocean.com/community/tutorials/how-to-create-a-twitter-app) to register your app with Twitter and get credentials.
2928
- Adjust the file `feeds.txt` which contains the list of RSS feeds you want to crawl. Lines starting with `#` are ignored.
29+
- Inside the code, ajust the [regular expression](https://en.wikipedia.org/wiki/Regular_expression) that selects the papers of interest
30+
- Some extra parameters can be tweaked in configuration file `config.yml`.
3031

3132
## How to run
3233

3334
PapersBot tracks in a file named `posted.dat` (which it will create) the papers that have already been tweeted. The first time you run it, if there is no `posted.dat` from a prior run, PapersBot can thus post **a lot** of papers. If you want to avoid this, especially on the first run or if it hasn't been run for a long time, use the `--do-not-tweet` option.
3435

3536
`papersbot.py --do-not-tweet` will list the papers it _would_ tweet, without actually tweeting. But papers will still be recorded as tweeted in the `posted.dat` file.
37+
38+
## Other features
39+
40+
- Running `papersbot.py --top-tweets` will give you a list of the 5 top tweets, from the bot's 200 latest tweets. It sorts tweets by adding number of retweets and likes.

0 commit comments

Comments
 (0)