Skip to content

Commit 0a82e60

Browse files
committed
docs, set bound to super high just in case
1 parent c4e4a86 commit 0a82e60

2 files changed

Lines changed: 31 additions & 28 deletions

File tree

readme.md

Lines changed: 30 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,46 @@
1-
# Gorkit Bot
1+
## Gorkit Bot
22

3-
Gorkit is a Bluesky (AT Protocol) bot written in Rust. It monitors the network for specific mentions and automatically replies to them.
3+
Gorkit is a Bluesky (AT Protocol) bot written in Rust. Monitors specific posts and replies automatically.
44

5-
## Features
5+
### Features
66

7-
* Listens to the AT Protocol's event stream (Jetstream) for new posts.
8-
* Specifically filters for posts on the `app.bsky.feed.post` collection.
9-
* Identifies posts that contain the exact text "@gork is this true".
10-
* Replies to these mentions with the text "yeh".
11-
* Persists its progress (cursor) to avoid reprocessing old messages on restart.
12-
* Includes basic setup for tracing (logging) and Prometheus metrics.
7+
* Subscribes to the AT Protocol event stream (Jetstream).
8+
* Filters for posts in `app.bsky.feed.post`.
9+
* Detects exact match: `@gork.bluesky.bot is this true`.
10+
* Replies with `yeh`.
11+
* Saves cursor to avoid duplicate processing on restart.
12+
* Includes basic setup for tracing and Prometheus metrics.
1313

14-
## Prerequisites
14+
### Requirements
1515

16-
* Rust toolchain installed.
17-
* A Bluesky account.
16+
* Rust toolchain installed.
17+
* Bluesky account.
1818

19-
## Setup
19+
### Setup
2020

21-
1. **Clone the repository (if applicable)**
22-
```bash
23-
# git clone <your-repo-url>
24-
# cd gorkit
25-
```
21+
1. **Clone the repository (if needed)**
2622

27-
2. **Set Environment Variables**:
28-
The bot requires your Bluesky credentials to log in and post replies. Create a `.env` file in the root of the project directory with the following content:
23+
```bash
24+
git clone <your-repo-url>
25+
cd gorkit
26+
```
2927

30-
```env
31-
ATP_USER="your-bluesky-username"
32-
ATP_PASSWORD="your-bluesky-app-password"
33-
```
34-
Replace `your-bluesky-username` with your Bluesky handle (e.g., `example.bsky.social`) and `your-bluesky-app-password` with an app password you generate from your Bluesky account settings. **Do not use your main account password.**
28+
2. **Set environment variables**
3529

36-
## Running the Bot
30+
Create a `.env` file in the project root:
3731

38-
Once the environment variables are set up, you can run the bot using Cargo:
32+
```env
33+
ATP_USER="your-bluesky-username"
34+
ATP_PASSWORD="your-bluesky-app-password"
35+
```
36+
37+
Replace values accordingly.
38+
Use an app password, not your main account password.
39+
40+
### Run
3941

4042
```bash
4143
cargo run
4244
```
4345

44-
The bot will start, log in to Bluesky, and begin listening for mentions.
46+
Starts the bot, logs in, and listens for mentions.

src/main.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ async fn main() {
7070
let opts = JetstreamOptions::builder()
7171
// your EXACT nsids
7272
.wanted_collections(vec!["app.bsky.feed.post".to_string()])
73+
.bound(8 * 8 * 8 * 8 * 8 * 8) // 262144
7374
.build();
7475
// create the jetstream connector
7576
let jetstream = JetstreamConnection::new(opts);

0 commit comments

Comments
 (0)