Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tijszwinkels committed Nov 24, 2024
1 parent 1c8f534 commit ee923aa
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,19 @@

A real-time 3D visualization of BlueSky's jetstream (firehose) feed, where each post materializes as a marble in a physics-enabled environment. The visualization provides an engaging way to observe and analyze the flow of posts on the BlueSky social network.

# Usage

- Open [here](https://tijszwinkels.github.io/).
- [This is a pretty preconfigured one](https://tijszwinkels.github.io/bluesky-marbles/?fraction=1&size=0.5&words=hate%3A6cd926%2Clove%3A4f2aa4%2Chappy%3A0000ed%2Csad%3Ac4a4ce&onlySelected=true&timeout=91). (And, yes! - Love and happiness still wins!)

This is animation of marbles falling in a glass vase. Each message on [Bluesky](https://bsky.app/) fitting the filter criteria is a single marble.

Starting the app, no words are selected and every message gets a different color. On the right pane, counts of the different words in the jetstream are tracked. You can put a global filter at the top. By default, it's only showing 1% of all messages. Change the 'message fraction' configuration to change that.

Click one or multiple words to assign colors. Click on the color to change it. By default, all other marbles are still shown. Click the 'Only Selected Words' configuration to only show words with a color assigned. After doing this, you can likely increase the message fraction.

If the message fraction is 1, all messages going through bluesky are processed.

## Features

- **Real-time Visualization**: Each BlueSky post appears as a marble dropping into a transparent container
Expand Down Expand Up @@ -79,11 +92,6 @@ All settings can be controlled via URL parameters:
- `words`: Comma-separated list of word:color pairs
- `onlySelected`: Show only posts containing selected words

Example:
```
http://localhost:5173/?filter=tech&timeout=30&size=0.3&words=love:ff0000,hate:0000ff
```

## Credit

This software has been written almost entirely with [Cline](https://github.com/cline/cline) & [Claude Sonnet](https://www.anthropic.com/claude/sonnet).
Expand Down

0 comments on commit ee923aa

Please sign in to comment.