qtex 1.1.2 → 1.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +60 -36
  2. package/package.json +19 -8
package/README.md CHANGED
@@ -1,18 +1,26 @@
1
- # ⚡ qtex
1
+ # ⚡ qtex — Cloud LaTeX Compiler
2
2
 
3
3
  <p align="center">
4
- <img src="https://raw.githubusercontent.com/srsergiolazaro/qtex/main/docs/assets/banner.jpeg" alt="qtex Banner" width="500">
4
+ <img src="https://raw.githubusercontent.com/srsergiolazaro/qtex/main/docs/assets/banner.jpeg" alt="qtex - Cloud LaTeX Compiler" width="500">
5
5
  </p>
6
6
 
7
7
  <p align="center">
8
- <a href="https://www.npmjs.com/package/qtex"><img src="https://img.shields.io/npm/v/qtex?style=flat-square&logo=npm&color=cb3837" alt="NPM Version"></a>
9
- <a href="./LICENSE"><img src="https://img.shields.io/badge/License-Fair_Source-blue.svg?style=flat-square" alt="License"></a>
10
- <a href="https://latex.taptapp.xyz"><img src="https://img.shields.io/badge/Engine-Tectonic-8b5cf6?style=flat-square&logo=rust" alt="Engine"></a>
11
- <a href="#"><img src="https://img.shields.io/badge/Latency-<1s-22c55e?style=flat-square" alt="Latency"></a>
8
+ <a href="https://www.npmjs.com/package/qtex"><img src="https://img.shields.io/npm/v/qtex?style=flat-square&logo=npm&color=cb3837" alt="npm version"></a>
9
+ <a href="https://www.npmjs.com/package/qtex"><img src="https://img.shields.io/npm/dm/qtex?style=flat-square&color=blue" alt="npm downloads"></a>
10
+ <a href="./LICENSE"><img src="https://img.shields.io/badge/license-Fair_Source-blue?style=flat-square" alt="License"></a>
11
+ <a href="https://latex.taptapp.xyz"><img src="https://img.shields.io/badge/engine-Tectonic-8b5cf6?style=flat-square&logo=rust" alt="Tectonic Engine"></a>
12
12
  </p>
13
13
 
14
14
  <p align="center">
15
- <strong>Cloud LaTeX compiler. Sub-second builds. Zero setup.</strong>
15
+ <strong>Compile LaTeX documents in the cloud. Sub-second builds. Zero configuration.</strong><br>
16
+ No TeXLive. No MikTeX. No 5GB downloads. Just fast PDF generation.
17
+ </p>
18
+
19
+ <p align="center">
20
+ <a href="#install">Install</a> •
21
+ <a href="#usage">Usage</a> •
22
+ <a href="#features">Features</a> •
23
+ <a href="https://srsergiolazaro.github.io/qtex/">Website</a>
16
24
  </p>
17
25
 
18
26
  ---
@@ -29,62 +37,78 @@ curl -fsSL https://raw.githubusercontent.com/srsergiolazaro/qtex/main/install.sh
29
37
  irm https://raw.githubusercontent.com/srsergiolazaro/qtex/main/install.ps1 | iex
30
38
  ```
31
39
 
32
- **Or use directly without installing:**
40
+ **Or use directly with npx (zero install):**
33
41
  ```bash
34
42
  npx qtex ./my-project
35
43
  ```
36
44
 
37
- ---
38
-
39
- ## Features
40
-
41
- | Feature | Description |
42
- |---------|-------------|
43
- | ⚡ **Fast** | Rust-based Tectonic engine. Compile in milliseconds. |
44
- | 📦 **Zero Config** | No TeXLive, no MikTeX. No 5GB downloads. |
45
- | 👀 **Watch Mode** | Auto-recompile on save. Supports `.tex`, `.bib`, `.sty`, images. |
46
- | 🔍 **Validation** | Pre-flight syntax checks before compilation. |
47
- | 📂 **Multi-file** | Recursive asset discovery with nested folders. |
48
- | 🔒 **Private** | Stateless & ephemeral. Files never stored. |
45
+ **Or install globally via npm:**
46
+ ```bash
47
+ npm install -g qtex
48
+ ```
49
49
 
50
50
  ---
51
51
 
52
52
  ## Usage
53
53
 
54
54
  ```bash
55
- # Compile a project
56
- qtex ./my-project
55
+ # Compile a LaTeX project
56
+ qtex ./my-thesis
57
57
 
58
- # Watch mode (live recompilation)
59
- qtex ./my-project --watch
58
+ # Live watch mode auto-recompile on save
59
+ qtex ./my-thesis --watch
60
60
 
61
61
  # Custom output filename
62
- qtex ./my-project --output thesis.pdf
62
+ qtex ./my-thesis --output final.pdf
63
63
 
64
- # Help
64
+ # Show all options
65
65
  qtex --help
66
66
  ```
67
67
 
68
68
  ---
69
69
 
70
+ ## Features
71
+
72
+ | | Feature | Description |
73
+ |-|---------|-------------|
74
+ | ⚡ | **Blazing Fast** | Rust-based Tectonic engine compiles in milliseconds |
75
+ | 📦 | **Zero Config** | No TeXLive, no MikTeX, no local dependencies |
76
+ | 👀 | **Watch Mode** | Auto-recompile on `.tex`, `.bib`, `.sty`, and image changes |
77
+ | 🔍 | **Validation** | Pre-flight syntax checks before compilation |
78
+ | 📂 | **Multi-file** | Recursive asset discovery with nested folders |
79
+ | 🔒 | **Private** | Stateless & ephemeral — your files are never stored |
80
+
81
+ ---
82
+
70
83
  ## How it Works
71
84
 
72
85
  <p align="center">
73
- <img src="https://raw.githubusercontent.com/srsergiolazaro/qtex/main/docs/assets/flow.png" alt="qtex Workflow" width="600">
86
+ <img src="https://raw.githubusercontent.com/srsergiolazaro/qtex/main/docs/assets/flow.png" alt="qtex workflow diagram" width="600">
74
87
  </p>
75
88
 
76
- 1. **Scan** — Discover all TeX assets and dependencies
77
- 2. **Validate** — Pre-flight syntax check
78
- 3. **Compile** — Cloud processing via Tectonic
79
- 4. **Sync** — Download PDF locally
89
+ 1. **Scan** — Discover all `.tex` files and dependencies
90
+ 2. **Validate** — Pre-flight syntax check via API
91
+ 3. **Compile** — Cloud processing with Tectonic engine
92
+ 4. **Download** — Get your PDF instantly
93
+
94
+ ---
95
+
96
+ ## Why qtex?
97
+
98
+ | Traditional LaTeX | qtex |
99
+ |-------------------|------|
100
+ | 5GB+ TeXLive install | **Zero install** |
101
+ | Minutes to compile | **Milliseconds** |
102
+ | Complex setup | **One command** |
103
+ | Local resources | **Cloud-powered** |
80
104
 
81
105
  ---
82
106
 
83
- ## Infrastructure
107
+ ## API & Infrastructure
84
108
 
85
109
  - **Endpoint**: `https://latex.taptapp.xyz`
86
- - **Engine**: Tectonic (Rust / XeTeX)
87
- - **Privacy**: Stateless processing. Data never stored.
110
+ - **Engine**: [Tectonic](https://tectonic-typesetting.github.io/) (Rust/XeTeX)
111
+ - **Privacy**: Stateless processing data is never stored
88
112
 
89
113
  ---
90
114
 
@@ -92,8 +116,8 @@ qtex --help
92
116
 
93
117
  **Fair Source License**
94
118
 
95
- - ✅ Free for individuals and teams up to 3 users
96
- - 📧 Contact for enterprise/commercial use
119
+ ✅ Free for individuals and teams 3 users
120
+ 📧 Contact for enterprise licensing
97
121
 
98
122
  See [LICENSE](./LICENSE) for details.
99
123
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "qtex",
3
- "version": "1.1.2",
4
- "description": "Vortex CLI: Ultra-fast cloud-based LaTeX compilation. Compile LaTeX documents in milliseconds using a high-performance Rust-powered engine without local TeX installation.",
3
+ "version": "1.1.3",
4
+ "description": "Ultra-fast cloud LaTeX compiler. Compile .tex documents in milliseconds without installing TeXLive or MikTeX. Zero config, sub-second builds, live watch mode.",
5
5
  "main": "index.js",
6
6
  "scripts": {
7
7
  "test": "echo \"Error: no test specified\" && exit 1",
@@ -12,13 +12,21 @@
12
12
  "latex",
13
13
  "tex",
14
14
  "compiler",
15
- "tectonic",
16
- "rust",
15
+ "pdf",
16
+ "latex-compiler",
17
17
  "cloud-latex",
18
- "pdf-generator",
19
- "vortex",
18
+ "tectonic",
19
+ "xelatex",
20
+ "pdflatex",
21
+ "academic",
22
+ "thesis",
23
+ "paper",
24
+ "document",
25
+ "typesetting",
26
+ "markdown-to-pdf",
20
27
  "cli",
21
- "typesetting"
28
+ "fast",
29
+ "rust"
22
30
  ],
23
31
  "author": "Sergio Lázaro (srsergio)",
24
32
  "repository": {
@@ -28,7 +36,7 @@
28
36
  "bugs": {
29
37
  "url": "https://github.com/srsergiolazaro/qtex/issues"
30
38
  },
31
- "homepage": "https://github.com/srsergiolazaro/qtex#readme",
39
+ "homepage": "https://srsergiolazaro.github.io/qtex/",
32
40
  "license": "SEE LICENSE IN LICENSE",
33
41
  "type": "module",
34
42
  "bin": {
@@ -42,5 +50,8 @@
42
50
  ],
43
51
  "directories": {
44
52
  "example": "example"
53
+ },
54
+ "engines": {
55
+ "node": ">=18"
45
56
  }
46
57
  }