Skip to content

Commit 4677a44

Browse files
committed
feat: Add install instructions to README
1 parent 6a24db0 commit 4677a44

1 file changed

Lines changed: 54 additions & 11 deletions

File tree

README.md

Lines changed: 54 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,60 @@
1-
# linkdqueue
1+
# Linkdqueue
22

3-
A new Flutter project.
3+
A reading queue manager for [Linkding](https://github.com/sissbruecker/linkding) bookmarks. Browse your unread bookmarks, filter by tag, mark articles as read, and manage tags — all from a native desktop or mobile app.
44

5-
## Getting Started
5+
## Installation
66

7-
This project is a starting point for a Flutter application.
7+
Download the latest release for your platform from the [Releases](../../releases) page.
88

9-
A few resources to get you started if this is your first Flutter project:
9+
### macOS
1010

11-
- [Learn Flutter](https://docs.flutter.dev/get-started/learn-flutter)
12-
- [Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
13-
- [Flutter learning resources](https://docs.flutter.dev/reference/learning-resources)
11+
1. Download `linkdqueue-macos.zip` and unzip it.
12+
2. Move `linkdqueue.app` to your `/Applications` folder.
13+
3. On first launch, right-click the app and choose **Open** to bypass Gatekeeper (required once for apps not from the App Store).
1414

15-
For help getting started with Flutter development, view the
16-
[online documentation](https://docs.flutter.dev/), which offers tutorials,
17-
samples, guidance on mobile development, and a full API reference.
15+
### Linux
16+
17+
1. Download `linkdqueue-linux.tar.gz` and extract it:
18+
```bash
19+
tar -xzvf linkdqueue-linux.tar.gz -C ~/Applications/linkdqueue
20+
```
21+
2. Install the runtime dependency for secure credential storage:
22+
```bash
23+
# Debian / Ubuntu
24+
sudo apt install libsecret-1-0
25+
26+
# Fedora / RHEL
27+
sudo dnf install libsecret
28+
29+
# Arch
30+
sudo pacman -S libsecret
31+
```
32+
3. Run the app:
33+
```bash
34+
~/Applications/linkdqueue/linkdqueue
35+
```
36+
Optionally create a desktop shortcut pointing to that path.
37+
38+
### Windows
39+
40+
1. Download `linkdqueue-windows.zip` and unzip it to a folder of your choice (e.g. `C:\Program Files\Linkdqueue`).
41+
2. Run `linkdqueue.exe` inside that folder.
42+
3. Optionally right-click `linkdqueue.exe` and choose **Pin to Start** or **Send to > Desktop (create shortcut)**.
43+
44+
## Setup
45+
46+
On first launch you will be prompted for your Linkding connection details:
47+
48+
- **Linkding URL** — the base URL of your Linkding instance (e.g. `https://linkding.example.com`)
49+
- **API Token** — found in Linkding under **Settings > Integrations**
50+
51+
Use **Test Connection** to verify before saving.
52+
53+
## Features
54+
55+
- Browse your unread bookmark queue with infinite scroll
56+
- Filter by tag or free-text search
57+
- Mark bookmarks as read, archive, or delete
58+
- Edit tags on any bookmark
59+
- Swipe actions on mobile (mark read, archive)
60+
- Adjustable text size and colour theme

0 commit comments

Comments
 (0)