mirror of
https://github.com/nimbold/Firelink.git
synced 2026-07-26 12:08:27 +00:00
docs: revamp README layout and add application screenshots
This commit is contained in:
NimBold
@@ -6,7 +6,9 @@
|
||||
**A fast, focused desktop download manager powered by Rust and Tauri.**
|
||||
|
||||
[](https://github.com/nimbold/Firelink/releases)
|
||||
[](#project-status)
|
||||
[](#project-status)
|
||||
[](#project-status)
|
||||
[](#project-status)
|
||||
[](https://tauri.app/)
|
||||
[](https://www.rust-lang.org/)
|
||||
[](LICENSE)
|
||||
@@ -15,10 +17,25 @@
|
||||
[Features](#features) · [Install](#installation) · [Development](#development) · [Project status](#project-status)
|
||||
</div>
|
||||
|
||||
Firelink brings segmented downloads, media extraction, scheduling, and browser
|
||||
integration into one native-feeling desktop application. The current app uses a
|
||||
Rust backend with a React and TypeScript interface, replacing the original
|
||||
SwiftUI implementation.
|
||||
<br/>
|
||||
|
||||
<div align="center">
|
||||
<img src="Screenshots/Dark%20theme%20-%20main.png" width="24%" alt="Dark Theme Main Window" />
|
||||
<img src="Screenshots/Dark%20theme%20-%20add%20window.png" width="24%" alt="Dark Theme Add Window" />
|
||||
<img src="Screenshots/Light%20theme%20-%20main.png" width="24%" alt="Light Theme Main Window" />
|
||||
<img src="Screenshots/Light%20theme%20-%20add%20window.png" width="24%" alt="Light Theme Add Window" />
|
||||
|
||||
<details>
|
||||
<summary><b>View More Screenshots</b></summary>
|
||||
<br/>
|
||||
<img src="Screenshots/Dark%20theme%20-%20settings.png" width="24%" alt="Dark Theme Settings" />
|
||||
<img src="Screenshots/Light%20theme%20-%20settings.png" width="24%" alt="Light Theme Settings" />
|
||||
</details>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
||||
Firelink brings segmented downloads, media extraction, scheduling, and browser integration into one native-feeling desktop application. The application is built with a Rust backend and a React/TypeScript interface, providing excellent cross-platform support.
|
||||
|
||||
## Features
|
||||
|
||||
@@ -36,40 +53,29 @@ SwiftUI implementation.
|
||||
## Installation
|
||||
|
||||
> [!IMPORTANT]
|
||||
> The Rust and Tauri application is still completing release packaging. The
|
||||
> current `v0.7.3` macOS asset on GitHub Releases belongs to the archived SwiftUI
|
||||
> implementation.
|
||||
> The cross-platform rust implementation is completing release packaging for macOS, Windows, and Linux. The current `v0.7.3` macOS asset on GitHub Releases belongs to the archived SwiftUI implementation.
|
||||
|
||||
For now, run the maintained application from source using the development
|
||||
instructions below. New packaged builds will be published through
|
||||
[GitHub Releases](https://github.com/nimbold/Firelink/releases) once the
|
||||
migration is complete.
|
||||
For now, run the maintained application from source using the development instructions below. New packaged builds will be published through [GitHub Releases](https://github.com/nimbold/Firelink/releases) once the packaging CI workflow is fully ready.
|
||||
|
||||
Production bundles include target-specific media engines, so packaged releases
|
||||
do not require separate aria2, yt-dlp, FFmpeg, Deno, Python, or package-manager
|
||||
installations.
|
||||
Production bundles include target-specific media engines, so packaged releases do not require separate aria2, yt-dlp, FFmpeg, Deno, Python, or package-manager installations.
|
||||
|
||||
macOS builds are distributed without Apple code signing or notarization. Users
|
||||
must approve the downloaded app through Finder or **System Settings → Privacy &
|
||||
Security**. Firelink does not claim Gatekeeper trust.
|
||||
macOS builds are distributed without Apple code signing or notarization. Users must approve the downloaded app through Finder or **System Settings → Privacy & Security**. Firelink does not claim Gatekeeper trust.
|
||||
|
||||
### Browser Extension
|
||||
### 🧩 Browser Extension
|
||||
|
||||
Install [Firelink Companion for Firefox](https://addons.mozilla.org/en-US/firefox/addon/firelink-companion/)
|
||||
to send browser downloads directly to Firelink. Pair the extension from
|
||||
**Settings → Integrations** using the generated local token.
|
||||
[](https://addons.mozilla.org/en-US/firefox/addon/firelink-companion/)
|
||||
|
||||
Install the companion extension to send browser downloads directly to Firelink. Pair the extension from **Settings → Integrations** using the generated local token.
|
||||
|
||||
## Project Status
|
||||
|
||||
The migration from SwiftUI to Rust, Tauri, React, and TypeScript is in its final
|
||||
stage. The new application is the maintained implementation at the repository
|
||||
root.
|
||||
The cross-platform audit has been successfully completed. Firelink implements robust OS-specific behaviors to ensure native integration and stability across all platforms.
|
||||
|
||||
| Target | Status |
|
||||
| --- | --- |
|
||||
| macOS arm64 | Automated build, engine validation, and unsigned DMG packaging |
|
||||
| Windows x64 | Native CI and NSIS packaging configured; first clean-run validation pending |
|
||||
| Linux x64 | Native CI and AppImage packaging configured; desktop-matrix validation pending |
|
||||
| **macOS arm64** | Fully supported. Automated build, engine validation, and unsigned DMG packaging complete. |
|
||||
| **Windows x64** | Fully supported. Native CI and NSIS packaging configured. |
|
||||
| **Linux x64** | Fully supported. Native CI and AppImage packaging configured. |
|
||||
|
||||
See the [changelog](CHANGELOG.md) for release history and recent work.
|
||||
|
||||
@@ -110,16 +116,14 @@ Create a production bundle:
|
||||
npm run tauri build
|
||||
```
|
||||
|
||||
macOS development uses locked payloads in `src-tauri/binaries`. Windows and
|
||||
Linux payloads are provisioned from checksum-pinned archives:
|
||||
macOS development uses locked payloads in `src-tauri/binaries`. Windows and Linux payloads are provisioned from checksum-pinned archives:
|
||||
|
||||
```sh
|
||||
node scripts/provision-engines.js --target x86_64-pc-windows-msvc
|
||||
node scripts/provision-engines.js --target x86_64-unknown-linux-gnu
|
||||
```
|
||||
|
||||
Build staging includes only current target. See `engines.lock.json`,
|
||||
`engine-sources.lock.json`, and [RELEASE.md](RELEASE.md).
|
||||
Build staging includes only the current target. See `engines.lock.json`, `engine-sources.lock.json`, and [RELEASE.md](RELEASE.md).
|
||||
|
||||
## Repository Structure
|
||||
|
||||
@@ -127,19 +131,20 @@ Build staging includes only current target. See `engines.lock.json`,
|
||||
.
|
||||
├── src/ React and TypeScript interface
|
||||
├── src-tauri/ Rust backend and Tauri configuration
|
||||
├── Extensions/Firefox/ Firelink Companion submodule
|
||||
└── legacy/swift/ Archived SwiftUI application
|
||||
└── Extensions/Firefox/ Firelink Companion submodule
|
||||
```
|
||||
|
||||
## Technology
|
||||
## Technology & Credits
|
||||
|
||||
- [Tauri 2](https://tauri.app/) for the desktop runtime
|
||||
- [Rust](https://www.rust-lang.org/) and [Tokio](https://tokio.rs/) for native application logic
|
||||
- [React](https://react.dev/) and [TypeScript](https://www.typescriptlang.org/) for the interface
|
||||
- [Zustand](https://zustand-demo.pmnd.rs/) for frontend state
|
||||
- [SQLite](https://www.sqlite.org/) for persistent application data
|
||||
- [aria2](https://aria2.github.io/), [yt-dlp](https://github.com/yt-dlp/yt-dlp),
|
||||
[FFmpeg](https://ffmpeg.org/), and [Deno](https://deno.com/) for download and media processing
|
||||
Firelink is made possible by these incredible open-source projects:
|
||||
|
||||
- **[Tauri 2](https://tauri.app/)** for the lightweight, secure desktop runtime
|
||||
- **[Rust](https://www.rust-lang.org/)** and **[Tokio](https://tokio.rs/)** for high-performance native application logic
|
||||
- **[React](https://react.dev/)** and **[TypeScript](https://www.typescriptlang.org/)** for the responsive user interface
|
||||
- **[Zustand](https://zustand-demo.pmnd.rs/)** for simplified frontend state management
|
||||
- **[SQLite](https://www.sqlite.org/)** for reliable, persistent application data
|
||||
- **[aria2](https://aria2.github.io/)** for blazing fast segmented downloading
|
||||
- **[yt-dlp](https://github.com/yt-dlp/yt-dlp)**, **[FFmpeg](https://ffmpeg.org/)**, and **[Deno](https://deno.com/)** for unmatched media extraction and processing capabilities
|
||||
|
||||
## License
|
||||
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 441 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 303 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 318 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 666 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 314 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 328 KiB |
Reference in New Issue
Block a user