Skip to content

Commit 819d930

Browse files
committed
update readme
1 parent 6229be2 commit 819d930

File tree

1 file changed

+26
-5
lines changed

1 file changed

+26
-5
lines changed

README.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
# reddit-rss
2+
23
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/trashhalo/reddit-rss)
34
[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/I3I72N2AC)
45
[reddit post explaining what this is](https://www.reddit.com/r/rss/comments/fvg3ed/i_built_a_better_rss_feed_for_reddit/)
56

67
## Breaking Changes
8+
79
If you follow this service, please add the announcements rss feed to your reader to be notified of incoming changes.
810

911
`https://github.com/trashhalo/reddit-rss/discussions/categories/announcements.atom`
1012

11-
- Limit has been renamed scoreLimit. https://github.com/trashhalo/reddit-rss/issues/46
13+
- Limit has been renamed scoreLimit. https://github.com/trashhalo/reddit-rss/issues/46
1214

1315
## installation
1416

@@ -19,13 +21,29 @@ Your options are `docker build .` or `go build ./cmd/reddit-rss`.
1921
If you run a version of reddit-rss at https://reddit.my.server
2022

2123
If you are interested in using it to you:
24+
2225
1. Go to a subreddit or meta feed you like example: https://www.reddit.com/r/Android/
2326
2. Add .json onto the end: https://www.reddit.com/r/Android.json
2427
3. Change the domain name to, reddit.0qz.fun like: https://reddit.my.server/r/android.json
2528
4. Subscribe to ^^^ that url in your favorite feed reader.
2629

30+
### OAUTH
31+
32+
To get access to better rate limits, you can set up an oauth app on reddit and provide the client id and secret as environment variables.
33+
Be sure to select script when asked what kind of app you are.
34+
<https://old.reddit.com/prefs/apps/>
35+
36+
```
37+
OAUTH_CLIENT_ID=your_client_id # its that id in the top left of the reddit app page
38+
OAUTH_CLIENT_SECRET=yout_client_secret # its the secret under the id
39+
REDDIT_USERNAME=your_reddit_username # the username of the account you created the app with
40+
REDDIT_PASSWORD=your_reddit_password # the password of the account you created the app with
41+
USER_AGENT="browser:name-of-app:v1.0.0 (by /u/your-reddit-username)"
42+
```
43+
2744
## exposed ports
28-
- 8080 (HTTP)
45+
46+
- 8080 (HTTP)
2947

3048
## query params
3149

@@ -46,11 +64,14 @@ to further configure your instance, you can set the following environment variab
4664

4765
this controls which interface you want your rss feed entries to link to (to avoid tracking and that annoying use mobile app popup). any alternative reddit interface can be provided here, ie: https://libredd.it or https://teddit.net .
4866

49-
50-
it defaults to ```"https://old.reddit.com"```.
67+
it defaults to `"https://old.reddit.com"`.
5168

5269
### PORT
5370

5471
which port your instance is listening on.
5572

56-
defaults to ```"8080"```
73+
defaults to `"8080"`
74+
75+
```
76+
77+
```

0 commit comments

Comments
 (0)