Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 5 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,12 @@
# Contributing to torlink
# Contributing to Klink

torlink stays small on purpose. The best way in is to read the code you're about to touch, match how it already works, and keep your change tight. Three recent pull requests set the bar, and this guide points back at them throughout:

- [#4](https://github.com/baairon/torlink/pull/4) gave the arrow keys spatial pane navigation without breaking a single existing shortcut.
- [#5](https://github.com/baairon/torlink/pull/5) turned a cryptic crash on old Node into a one-line "upgrade me" message.
- [#6](https://github.com/baairon/torlink/pull/6) added copy-magnet, cross-platform, with tests.

None of them were big. All of them fit the grain. That's the whole idea.
Klink is an enhanced fork of torlink. The best way in is to read the code you're about to touch, match how it already works, and keep your change tight.

## Set up

```sh
git clone https://github.com/baairon/torlink
cd torlink
git clone https://github.com/kaiserc/klink
cd klink
npm install
npm run dev
```
Expand Down Expand Up @@ -71,4 +65,4 @@ torlink is pastel-violet and quiet. There is exactly one gradient, the wordmark
- Say why, not just what. The diff already shows the what.
- One concern per pull request. Two unrelated ideas are two PRs.

Thanks for helping keep torlink sharp.
Thanks for helping keep Klink sharp.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ Klink expands on upstream torlink with key power-user features:
- 🎬 **Direct Media Streaming & Themed Web UI**: Stream video files directly over HTTP while downloading (`klink serve` / `klink files`), with an integrated web interface featuring a dark/light theme switcher.
- ✅ **Completed Tab & Smart File Organisation**: Cleanly separate active downloads, seeding items, and finished downloads with directory routing.
- ⚠️ **Action Confirmation Dialogs**: Safety confirmation prompts before destructive actions like cancelling downloads or clearing history to prevent accidental data loss.
- 📥 **Drag-and-Drop & Clipboard `.torrent` Support**: Drop a `.torrent` file directly onto the terminal or paste its path/URI into the search bar to enqueue it instantly.
- 📡 **Private Tracker Announce Preservation**: Intact tracker list and passkey preservation when loading `.torrent` files.
- ✨ **High-Contrast UI Row Highlights**: Full-row active bolding and dimming across all columns in Results, Downloads, and Seeding views.
- 🔧 **WebTorrent stability patch**: Guards against a null-pointer crash in `_request` introduced in webtorrent 3.x, keeping the daemon stable under heavy peer churn.

---
Expand All @@ -40,7 +43,7 @@ Klink expands on upstream torlink with key power-user features:
npx klink
```

That's the only thing you'll type. Klink opens straight to a search bar: search for what you want, paste in a magnet link or a bare infohash, or just press Enter on an empty box to browse the curated library. From there it's all keypresses, nothing to memorise, and `?` brings up the full list anytime.
That's the only thing you'll type. Klink opens straight to a search bar: search for what you want, paste in a magnet link or a bare infohash, drop a `.torrent` file onto the window, or just press Enter on an empty box to browse the curated library. From there it's all keypresses, nothing to memorise, and `?` brings up the full list anytime.

## Finding something

Expand Down Expand Up @@ -129,6 +132,7 @@ Before opening a PR, skim [CONTRIBUTING.md](CONTRIBUTING.md); it lays out the ba
| Media Streaming | ❌ | ✅ |
| Completion Tab | ❌ | ✅ |
| Confirmation Dialogs | ❌ | ✅ |
| Expanded Categories (E-Books & Audiobooks) | ❌ | ✅ |
| WebTorrent null-ref patch | ❌ | ✅ |

## Privacy
Expand Down
Loading