Skip to content

Commit 8487c36

Browse files
committed
feat: Enhance README and package.json for clarity and discoverability
This commit improves the README file by adding clarity to the installation instructions, changing the heading level for better readability, and reformatting the code blocks. It also updates the package.json file by adding relevant keywords to improve discoverability on npm.
1 parent e5c9878 commit 8487c36

File tree

2 files changed

+27
-19
lines changed

2 files changed

+27
-19
lines changed

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ A command-line interface (CLI) that streamlines WordPress theme development. It
1212
- [✨ Key Features](#-key-features)
1313
- [🚀 Getting Started](#-getting-started)
1414
- [Prerequisites](#prerequisites)
15-
- [Installation](#installation)
15+
- [Installation](#installation)
1616
- [🚀 Usage](#-usage)
1717
- [`build` Command](#build-command)
1818
- [`new` Command](#new-command)
@@ -62,31 +62,31 @@ A command-line interface (CLI) that streamlines WordPress theme development. It
6262

6363
- Node.js version 18.0.0 or higher
6464

65-
## Installation
65+
### Installation
6666

67-
1. Install the package globally (recommended):
67+
- Install the package globally (recommended):
6868

69-
```bash
70-
npm install -g php-theme-gen
71-
```
69+
```bash
70+
npm install -g php-theme-gen
71+
```
7272

73-
The `phpgen` app is available globally. In any folder on your computer, check it runs:
73+
The `phpgen` app is available globally. In any folder on your computer, check it runs:
7474

75-
```bash
76-
phpgen -V
77-
```
75+
```bash
76+
phpgen -V
77+
```
7878

79-
2. Execute the package directly, using the `npx` command:
79+
- Execute the package directly, using the `npx` command:
8080

81-
```bash
82-
npx php-theme-gen [options] [command] [arguments]
81+
```bash
82+
npx php-theme-gen [options] [command] [arguments]
8383

84-
# e.g. for help
85-
# npx php-theme-gen -h
84+
# e.g. for help
85+
# npx php-theme-gen -h
8686

87-
# e.g. to build theme from index.html
88-
# npx php-theme-gen build demo/index.html --output demo/mytheme
89-
```
87+
# e.g. to build theme from index.html
88+
# npx php-theme-gen build demo/index.html --output demo/mytheme
89+
```
9090

9191
## 🚀 Usage
9292

package.json

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,15 @@
6666
"keywords": [
6767
"javascript",
6868
"starter",
69-
"node"
69+
"node",
70+
"wordpress",
71+
"theme",
72+
"generator",
73+
"cli",
74+
"html-to-php",
75+
"scaffolding",
76+
"development",
77+
"php"
7078
],
7179
"author": "Ion Gireada (https://github.com/ioncakephper)",
7280
"license": "MIT",

0 commit comments

Comments
 (0)