pphlx 1.0.1 → 1.0.2

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 +33 -17
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -4,35 +4,41 @@
4
4
  ![npm downloads](https://img.shields.io/npm/dm/pphlx)
5
5
  ![License](https://img.shields.io/npm/l/pphlx)
6
6
 
7
- Official Node.js CLI for **PPHLX**, a high-performance component compiler that transforms modern component-based layouts into production-ready PHP applications.
7
+ > Modern web components. Zero runtime. Pure PHP output.
8
+
9
+ Official Node.js CLI for PPHLX — a high-performance compiler for building modern, component-based PHP applications.
8
10
 
9
11
  Powered by a Go-compiled WebAssembly (WASI) runtime, PPHLX runs consistently on Windows, macOS, and Linux without requiring native compiler installations.
10
12
 
11
13
  ---
12
14
 
13
- ## Installation
15
+ ## Features
14
16
 
15
- Install the package locally in your project:
16
- ```bash
17
- npm install pphlx
18
- ```
17
+ - **🚀 High-performance compiler**: Powered by Go and compiled natively.
18
+ - **⚡ WebAssembly (WASI) powered**: Run anywhere Node.js runs without native compiler dependencies.
19
+ - **📦 Zero runtime in production**: The generated output is standalone, with no node modules.
20
+ - **🧩 Component-based layout**: Build components using your favorite frontend workflows.
21
+ - **🔥 Hot reload**: Fast development server built-in.
22
+ - **🌍 Cross-platform**: Instant startup on Windows, macOS, and Linux.
23
+ - **🐘 Generates pure PHP**: Easily host your builds on any cheap PHP web hosting server.
19
24
 
20
25
  ---
21
26
 
22
27
  ## Quick Start
23
28
 
24
- Initialize a new PPHLX project configuration:
29
+ Get your project up and running in seconds:
30
+
25
31
  ```bash
32
+ # Install PPHLX locally
33
+ npm install pphlx
34
+
35
+ # Initialize your project configuration
26
36
  npx pphlx init
27
- ```
28
37
 
29
- Start the local development and watch server:
30
- ```bash
38
+ # Start the local development server (with hot reload)
31
39
  npx pphlx dev
32
- ```
33
40
 
34
- Build your project into pure, production-ready `.php` files:
35
- ```bash
41
+ # Build for production deployment
36
42
  npx pphlx build
37
43
  ```
38
44
 
@@ -40,10 +46,12 @@ npx pphlx build
40
46
 
41
47
  ## Usage
42
48
 
43
- PPHLX uses a configuration file (`pphlx.config.json` or `pphlx.config.mjs`) in the root of your project directory.
49
+ PPHLX compiles your components into dependency-free, production-ready PHP pages. The generated output requires no Node.js, JavaScript runtime, or PPHLX framework in production.
50
+
51
+ By default, the compiler looks for a configuration file (`pphlx.config.json` or `pphlx.config.mjs`) in the root of your project directory.
44
52
 
45
- ### Scripts
46
- Add build and development trigger scripts to your `package.json`:
53
+ ### package.json Scripts
54
+ Add build and development triggers to your project scripts:
47
55
  ```json
48
56
  {
49
57
  "scripts": {
@@ -57,4 +65,12 @@ Then run:
57
65
  ```bash
58
66
  npm run build
59
67
  ```
60
- This compiles your layout and components into standalone `.php` files inside your output directory.
68
+ This compiles your layouts and components into standalone `.php` files inside your output directory.
69
+
70
+ ---
71
+
72
+ ## Project Links
73
+
74
+ - **Website**: [pphlx.org](https://pphlx.org)
75
+ - **GitHub Repository**: [github.com/pphlx/pphlx](https://github.com/pphlx/pphlx)
76
+ - **Discord Community**: [Discord Server](https://discord.gg/9ApeZhsG7G)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pphlx",
3
- "version": "1.0.1",
3
+ "version": "1.0.2",
4
4
  "description": "High-performance Monolithic Web Compiler and PHP Hydration CLI",
5
5
  "main": "bin/pphlx.js",
6
6
  "bin": {