Skip to content

Commit 227a7dc

Browse files
committed
docs: improve README setup instructions
1 parent cc4eff2 commit 227a7dc

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,10 @@ gleam run
4646

4747
## Setup
4848

49-
1. Create a `.env` file and fill in the values (you can use `.env.example` as a template):
49+
### 1. Set the environment variables
50+
51+
Create a `.env` file and fill in the values (you can use `.env.example` as a template):
52+
5053
```.env
5154
# Your Reddit username and password
5255
REDDIT_USERNAME=
@@ -61,7 +64,10 @@ REDDIT_CLIENT_SECRET=
6164
TELEGRAM_TOKEN=
6265
```
6366

64-
2. Create the file `bridges.json` and fill in the values for the subreddits and channels you want to bridge (you can use `bridges.example.json` as a template):
67+
### 2. Define the bridges
68+
69+
Create the file `bridges.json` and fill in the values for the subreddits and channels you want to bridge (you can use `bridges.example.json` as a template):
70+
6571
```json
6672
[
6773
{
@@ -80,4 +86,3 @@ TELEGRAM_TOKEN=
8086
| `minimum_upvotes` | (Optional) The minimum number of upvotes a post must have to be sent to the channel. Default is `10` |
8187
| `flair_include` | (Optional) When defined, only posts with a flair that is in the list will be sent to the channel. Default is `[]` |
8288
| `flair_exclude` | (Optional) When defined, posts with a flair that is in the list will not be sent to the channel. Default is `[]` |
83-

0 commit comments

Comments
 (0)