docs: update README

This commit is contained in:
2026-04-30 18:57:02 +02:00
parent 97880c2cd1
commit 0ae1b094c5
5 changed files with 31 additions and 2 deletions
+1
View File
@@ -1,3 +1,4 @@
config.toml
cookies.json
dist/
.DS_Store
+30 -2
View File
@@ -2,11 +2,39 @@
> Based on : https://github.com/rdavydov/Twitch-Channel-Points-Miner-v2
> Clanker disclosure : ALL of the code is GPT 5.5 generated ( reviewed )
> Clanker disclosure : ALL of the code is GPT 5.5 generated
A cli only lightweight Twitch channel points miner.
Needs config at working directory
### Installing
Install from aur
```
paru -S parasocial
yay -S parasocial
```
Or download a binary from releases.
### Config
Needs a `config.toml` at working directory with following shape
```toml
streamers = [ "streamer1", "streamer2" ]
```
The cli does not have a daemon mode, intended usage is with screen as following
```bash
screen -S parasocial # to create a session
parasocial # to start
# Ctrl a then d to detach
screen -r parasocial # to reattach
```
Usage: Arrow keys to move, q to quit.
### Screens
![](screens/screen1.png)
![](screens/screen2.png)
![](screens/screen3.png)
Binary file not shown.

After

Width:  |  Height:  |  Size: 114 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 292 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 115 KiB