pdflinux 0.1.1 → 0.1.2

package/README.md

@@ -1,45 +1,39 @@
 # PDFLinux
 
-> **100% Free. No subscription. No account. Your files never leave your computer.**
+[![npm version](https://img.shields.io/npm/v/pdflinux.svg)](https://www.npmjs.com/package/pdflinux)
+[![npm downloads](https://img.shields.io/npm/dm/pdflinux.svg)](https://www.npmjs.com/package/pdflinux)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
+[![Platform](https://img.shields.io/badge/platform-linux-lightgrey.svg)](#install)
+
+> **100% free. No subscription. No account. Your files never leave your computer.**
 
 A fast, privacy-first desktop application for all your everyday PDF tasks. Built with Tauri + Rust on the backend and React + TypeScript on the frontend — runs entirely on your local machine, no internet connection required, no files uploaded anywhere.
 
 ---
 
-## Install
-
-### Option 1 — Git Clone (recommended)
+## Table of Contents
 
-```bash
-git clone https://github.com/saaandbite/pdflinux.git
-cd pdflinux
-./install.sh
-```
-
-The `install.sh` script will automatically:
-- Detect your distro (Debian/Ubuntu, Fedora/RHEL/CentOS, Arch, etc.)
-- Install all required dependencies
-- Build the application
-- Install the appropriate package (`.deb` / `.rpm` / `AppImage`) for your distro
-- Add a shortcut to your app menu and a `pdflinux` command in the terminal
+- [Quick Install](#quick-install)
+- [Why PDFLinux?](#why-pdflinux)
+- [Features](#features)
+- [Prerequisites](#prerequisites)
+- [Installation](#installation)
+- [Tech Stack](#tech-stack)
+- [Development](#development)
+- [Project Structure](#project-structure)
+- [Contributing](#contributing)
+- [License](#license)
+- [Privacy](#privacy)
 
-To uninstall:
-```bash
-./uninstall.sh
-```
-
-### Option 2 — npx (via npm)
+---
 
-If you already have Node.js installed:
+## Quick Install
 
 ```bash
 npx pdflinux
 ```
 
-To uninstall:
-```bash
-npx pdflinux uninstall
-```
+That's it. The installer detects your distro, installs all dependencies, builds the app, and adds it to your application menu.
 
 ---
 
@@ -51,11 +45,14 @@ Most online PDF tools require you to upload your files to their servers. For sen
 - **Privacy-first** — zero network requests, zero telemetry
 - **Lightweight** — powered by Tauri (uses the OS native webview, not a bundled Chromium like Electron)
 - **Linux-first** — primary target is Linux; Windows and macOS are also supported via Tauri
+- **Open source** — auditable, forkable, yours
 
 ---
 
 ## Features
 
+17 PDF tools, all running locally on your machine:
+
 | Tool | Description |
 |---|---|
 | **Compress** | Reduce PDF file size using Ghostscript with quality presets |
@@ -78,6 +75,66 @@ Most online PDF tools require you to upload your files to their servers. For sen
 
 ---
 
+## Prerequisites
+
+PDFLinux requires a few native CLI utilities to do the heavy lifting. The installer will install these for you automatically, but here is the list for reference:
+
+- **Ghostscript** — for compression and color operations
+- **Poppler** — for PDF-to-image conversion and text extraction
+- **QPDF** — for encryption, decryption, and page operations
+- **Tesseract** — for OCR
+
+The installer also requires:
+- A supported Linux distro (Debian, Ubuntu, Fedora, RHEL, CentOS, Arch, openSUSE, or derivatives)
+- `sudo` privileges (to install system packages)
+- Internet access (during installation only)
+
+---
+
+## Installation
+
+### Option 1 — npx (easiest)
+
+If you already have Node.js installed:
+
+```bash
+npx pdflinux
+```
+
+To uninstall:
+```bash
+npx pdflinux uninstall
+```
+
+### Option 2 — Git Clone
+
+```bash
+git clone https://github.com/saaandbite/pdflinux.git
+cd pdflinux
+./install.sh
+```
+
+The `install.sh` script will automatically:
+- Detect your distro (Debian/Ubuntu, Fedora/RHEL/CentOS, Arch, etc.)
+- Install all required dependencies
+- Build the application
+- Install the appropriate package (`.deb` / `.rpm` / `AppImage`) for your distro
+- Add a shortcut to your app menu and a `pdflinux` command in the terminal
+
+To uninstall:
+```bash
+./uninstall.sh
+```
+
+### Launching the app
+
+After installation you can launch PDFLinux in two ways:
+
+- **Application menu** — search for "PDFLinux" in your desktop environment's app launcher
+- **Terminal** — run `pdflinux` from anywhere
+
+---
+
 ## Tech Stack
 
 | Layer | Technology |
@@ -96,7 +153,7 @@ Tauri uses the operating system's native webview (WebKitGTK on Linux) instead of
 
 ## Development
 
-To run from source:
+To run from source for local development:
 
 ```bash
 git clone https://github.com/saaandbite/pdflinux.git
@@ -131,12 +188,16 @@ pdflinux/
 │   ├── App.tsx                 # Route definitions
 │   └── main.tsx                # React entry point
 │
-└── src-tauri/                  # Rust backend (Tauri)
-    ├── src/
-    │   ├── main.rs             # Tauri entry point
-    │   └── pdf_engine.rs       # PDF processing logic (calls gs, qpdf, poppler)
-    ├── tauri.conf.json         # App window and build configuration
-    └── Cargo.toml              # Rust dependencies
+├── src-tauri/                  # Rust backend (Tauri)
+│   ├── src/
+│   │   ├── main.rs             # Tauri entry point
+│   │   └── pdf_engine.rs       # PDF processing logic (calls gs, qpdf, poppler)
+│   ├── tauri.conf.json         # App window and build configuration
+│   └── Cargo.toml              # Rust dependencies
+│
+├── bin/pdflinux                # npm CLI wrapper
+├── install.sh                  # Linux installer script
+└── uninstall.sh                # Linux uninstaller script
 ```
 
 ---
@@ -156,7 +217,7 @@ Please open an issue first for larger changes so we can discuss the approach.
 
 ## License
 
-This project is open source. See [LICENSE](./LICENSE) for details.
+This project is open source under the [MIT License](./LICENSE).
 
 ---
 

package/bin/pdflinux

@@ -1,9 +1,11 @@
 #!/usr/bin/env node
-'use strict';
+import { spawnSync } from 'node:child_process';
+import { resolve, dirname } from 'node:path';
+import { existsSync } from 'node:fs';
+import { fileURLToPath } from 'node:url';
 
-const { execFileSync, spawnSync } = require('child_process');
-const { resolve, dirname } = require('path');
-const { existsSync } = require('fs');
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
 
 const root = resolve(__dirname, '..');
 const installScript = resolve(root, 'install.sh');
@@ -14,7 +16,7 @@ const cmd = args[0];
 
 if (cmd === 'uninstall') {
     if (!existsSync(uninstallScript)) {
-        console.error('uninstall.sh tidak ditemukan.');
+        console.error('uninstall.sh not found.');
         process.exit(1);
     }
     const result = spawnSync('bash', [uninstallScript], { stdio: 'inherit' });
@@ -23,7 +25,7 @@ if (cmd === 'uninstall') {
 
 // Default: install
 if (!existsSync(installScript)) {
-    console.error('install.sh tidak ditemukan.');
+    console.error('install.sh not found.');
     process.exit(1);
 }
 

package/install.sh

@@ -39,7 +39,7 @@ detect_pkg_manager() {
 
 install_system_deps() {
     local pm="$1"
-    info "Menginstal dependensi sistem PDF (Ghostscript, Poppler, QPDF, Tesseract)..."
+    info "Installing PDF system dependencies (Ghostscript, Poppler, QPDF, Tesseract)..."
 
     case "$pm" in
         apt)
@@ -73,7 +73,7 @@ install_system_deps() {
                 pkg-config gcc curl wget
             ;;
         *)
-            warn "Package manager tidak dikenali. Pastikan dependensi berikut sudah terinstal:"
+            warn "Package manager not recognized. Make sure these are installed:"
             warn "  ghostscript, poppler-utils, qpdf, tesseract-ocr"
             ;;
     esac
@@ -81,21 +81,21 @@ install_system_deps() {
 
 install_rust() {
     if command -v rustup &>/dev/null && rustup show active-toolchain &>/dev/null; then
-        success "Rust sudah terinstal: $(rustc --version)"
+        success "Rust already installed: $(rustc --version)"
         return
     fi
-    info "Menginstal Rust via rustup..."
+    info "Installing Rust via rustup..."
     curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --no-modify-path
     export PATH="$HOME/.cargo/bin:$PATH"
-    success "Rust terinstal: $(rustc --version)"
+    success "Rust installed: $(rustc --version)"
 }
 
 install_node() {
     if command -v node &>/dev/null; then
-        success "Node.js sudah terinstal: $(node --version)"
+        success "Node.js already installed: $(node --version)"
         return
     fi
-    info "Menginstal Node.js via NodeSource..."
+    info "Installing Node.js via NodeSource..."
     local pm="$1"
     case "$pm" in
         apt)
@@ -113,21 +113,21 @@ install_node() {
             sudo zypper install -y nodejs npm
             ;;
         *)
-            error "Silakan install Node.js LTS secara manual dari https://nodejs.org/ lalu jalankan ulang script ini."
+            error "Please install Node.js LTS manually from https://nodejs.org/ then run this script again."
             ;;
     esac
-    success "Node.js terinstal: $(node --version)"
+    success "Node.js installed: $(node --version)"
 }
 
 build_app() {
-    info "Menginstal dependensi npm..."
+    info "Installing npm dependencies..."
     npm ci --silent
 
-    info "Membangun aplikasi (ini mungkin butuh beberapa menit pertama kali)..."
+    info "Building application (this may take a few minutes the first time)..."
     export PATH="$HOME/.cargo/bin:$PATH"
     npm run tauri build
 
-    success "Build selesai."
+    success "Build complete."
 }
 
 install_package() {
@@ -139,9 +139,9 @@ install_package() {
             local deb
             deb=$(find "$bundle_dir/deb" -name "*.deb" 2>/dev/null | head -1)
             if [ -n "$deb" ]; then
-                info "Menginstal paket .deb: $deb"
+                info "Installing .deb package: $deb"
                 sudo dpkg -i "$deb"
-                success "$DISPLAY_NAME berhasil diinstal."
+                success "$DISPLAY_NAME installed successfully."
                 return
             fi
             ;;
@@ -149,9 +149,9 @@ install_package() {
             local rpm
             rpm=$(find "$bundle_dir/rpm" -name "*.rpm" 2>/dev/null | head -1)
             if [ -n "$rpm" ]; then
-                info "Menginstal paket .rpm: $rpm"
+                info "Installing .rpm package: $rpm"
                 sudo "$pm" install -y "$rpm"
-                success "$DISPLAY_NAME berhasil diinstal."
+                success "$DISPLAY_NAME installed successfully."
                 return
             fi
             ;;
@@ -159,17 +159,17 @@ install_package() {
             ;;
     esac
 
-    # Fallback ke AppImage
+    # Fallback to AppImage
     local appimage
     appimage=$(find "$bundle_dir/appimage" -name "*.AppImage" 2>/dev/null | head -1)
     if [ -n "$appimage" ]; then
-        info "Menginstal AppImage..."
+        info "Installing AppImage..."
         local install_dir="$HOME/.local/bin"
         mkdir -p "$install_dir"
         cp "$appimage" "$install_dir/$APP_NAME"
         chmod +x "$install_dir/$APP_NAME"
 
-        # Tambahkan ke PATH jika belum ada
+        # Add to PATH if not already there
         local shell_rc=""
         case "$SHELL" in
             */bash) shell_rc="$HOME/.bashrc" ;;
@@ -178,15 +178,15 @@ install_package() {
         esac
         if [ -n "$shell_rc" ] && ! grep -q "$install_dir" "$shell_rc" 2>/dev/null; then
             echo "export PATH=\"$install_dir:\$PATH\"" >> "$shell_rc"
-            warn "PATH diperbarui di $shell_rc. Jalankan: source $shell_rc"
+            warn "PATH updated in $shell_rc. Run: source $shell_rc"
         fi
 
         install_desktop_file "$appimage"
-        success "$DISPLAY_NAME berhasil diinstal sebagai AppImage."
+        success "$DISPLAY_NAME installed as AppImage."
         return
     fi
 
-    error "Tidak ada installer yang ditemukan di $bundle_dir"
+    error "No installer found in $bundle_dir"
 }
 
 install_desktop_file() {
@@ -205,7 +205,7 @@ install_desktop_file() {
 [Desktop Entry]
 Type=Application
 Name=PDFLinux
-Comment=Privacy-first PDF tools untuk Linux — berjalan 100% offline
+Comment=Privacy-first PDF tools for Linux — runs 100% offline
 Exec=$exec_path
 Icon=$APP_NAME
 Categories=Office;Utility;
@@ -219,7 +219,7 @@ EOF
     if command -v gtk-update-icon-cache &>/dev/null; then
         gtk-update-icon-cache -f "$HOME/.local/share/icons/hicolor" &>/dev/null || true
     fi
-    success "Shortcut menu aplikasi ditambahkan."
+    success "Application menu shortcut added."
 }
 
 # ── Main ────────────────────────────────────────────────────────────────────
@@ -236,7 +236,7 @@ cd "$SCRIPT_DIR"
 DISTRO=$(detect_distro)
 PKG_MANAGER=$(detect_pkg_manager)
 
-info "Distro terdeteksi: $DISTRO (package manager: $PKG_MANAGER)"
+info "Detected distro: $DISTRO (package manager: $PKG_MANAGER)"
 
 install_system_deps "$PKG_MANAGER"
 install_rust
@@ -246,9 +246,9 @@ install_package "$PKG_MANAGER"
 
 echo ""
 echo -e "${GREEN}╔══════════════════════════════════════════════════════╗${NC}"
-echo -e "${GREEN}║   ✓ PDFLinux berhasil diinstal!                      ║${NC}"
+echo -e "${GREEN}║   ✓ PDFLinux installed successfully!                 ║${NC}"
 echo -e "${GREEN}║                                                      ║${NC}"
-echo -e "${GREEN}║   • Buka dari menu aplikasi: cari \"PDFLinux\"         ║${NC}"
-echo -e "${GREEN}║   • Atau jalankan via terminal: pdflinux              ║${NC}"
+echo -e "${GREEN}║   • Launch from app menu: search for \"PDFLinux\"      ║${NC}"
+echo -e "${GREEN}║   • Or run from terminal: pdflinux                   ║${NC}"
 echo -e "${GREEN}╚══════════════════════════════════════════════════════╝${NC}"
 echo ""

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "pdflinux",
-  "version": "0.1.1",
-  "description": "Privacy-first PDF tools untuk Linux — berjalan 100% offline",
+  "version": "0.1.2",
+  "description": "Privacy-first PDF tools for Linux — runs 100% offline",
   "keywords": ["pdf", "linux", "tools", "privacy", "tauri", "desktop"],
   "author": "saaandbite",
   "license": "MIT",

package/uninstall.sh

@@ -11,7 +11,6 @@ NC='\033[0m'
 
 info()    { echo -e "${BLUE}[*]${NC} $*"; }
 success() { echo -e "${GREEN}[✓]${NC} $*"; }
-error()   { echo -e "${RED}[✗]${NC} $*"; exit 1; }
 
 detect_pkg_manager() {
     if command -v apt &>/dev/null; then echo "apt"
@@ -30,30 +29,30 @@ echo -e "${RED}║   PDFLinux — Uninstall           ║${NC}"
 echo -e "${RED}╚══════════════════════════════════╝${NC}"
 echo ""
 
-# Hapus paket yang diinstal via package manager
+# Remove package installed via package manager
 case "$PM" in
     apt)
-        if dpkg -l "pdf-tools" &>/dev/null 2>&1; then
-            info "Menghapus paket .deb..."
-            sudo apt-get remove -y pdf-tools || true
+        if dpkg -l "pdflinux" &>/dev/null 2>&1; then
+            info "Removing .deb package..."
+            sudo apt-get remove -y pdflinux || true
         fi
         ;;
     dnf|yum)
-        if rpm -q "pdf-tools" &>/dev/null 2>&1; then
-            info "Menghapus paket .rpm..."
-            sudo "$PM" remove -y pdf-tools || true
+        if rpm -q "pdflinux" &>/dev/null 2>&1; then
+            info "Removing .rpm package..."
+            sudo "$PM" remove -y pdflinux || true
         fi
         ;;
 esac
 
-# Hapus AppImage
+# Remove AppImage
 if [ -f "$HOME/.local/bin/$APP_NAME" ]; then
-    info "Menghapus AppImage..."
+    info "Removing AppImage..."
     rm -f "$HOME/.local/bin/$APP_NAME"
 fi
 
-# Hapus .desktop file dan ikon
-info "Menghapus shortcut menu aplikasi..."
+# Remove .desktop file and icon
+info "Removing application menu shortcut..."
 rm -f "$HOME/.local/share/applications/$APP_NAME.desktop"
 rm -f "$HOME/.local/share/icons/hicolor/128x128/apps/$APP_NAME.png"
 
@@ -61,5 +60,5 @@ if command -v update-desktop-database &>/dev/null; then
     update-desktop-database "$HOME/.local/share/applications" &>/dev/null || true
 fi
 
-success "$DISPLAY_NAME berhasil dihapus."
+success "$DISPLAY_NAME removed successfully."
 echo ""