Skip to content

Commit 5a95076

Browse files
committed
feat: Add quick demo and update README for clarity and usage instructions
This commit introduces a quick demo to showcase the php-theme-gen functionality and updates the README file to provide clearer usage instructions and improve overall clarity. The table of contents in the README was also reorganized.
1 parent c3334df commit 5a95076

File tree

2 files changed

+33
-36
lines changed

2 files changed

+33
-36
lines changed

CHANGELOG.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22

33
## [1.1.0](https://github.com/ioncakephper/php-theme-gen/compare/v1.0.0...v1.1.0) (2025-08-09)
44

5-
65
### Features
76

8-
* Add quick demo and update README for clarity and usage instructions ([cee60cb](https://github.com/ioncakephper/php-theme-gen/commit/cee60cbc3a31b2e4ed035e7f046d5c2549ecd5c1))
7+
- Add quick demo and update README for clarity and usage instructions ([cee60cb](https://github.com/ioncakephper/php-theme-gen/commit/cee60cbc3a31b2e4ed035e7f046d5c2549ecd5c1))
98

109
## 1.0.0 (2025-08-09)
1110

README.md

Lines changed: 32 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -9,36 +9,38 @@ A command-line interface (CLI) that streamlines WordPress theme development. It
99

1010
## 📚 Table of Contents
1111

12-
- [✨ Key Features](#-key-features)
13-
- [🚀 Getting Started](#-getting-started)
14-
- [Prerequisites](#prerequisites)
15-
- [Installation](#installation)
16-
- [Quick demo](#quick-demo)
17-
- [🚀 Usage](#-usage)
18-
- [`build` Command](#build-command)
19-
- [`new` Command](#new-command)
20-
- [🚀 Available Scripts](#-available-scripts)
21-
- [Automated Documentation](#automated-documentation)
22-
- [Code Quality & Formatting](#code-quality--formatting)
23-
- [Core Development](#core-development)
24-
- [The "One-Click" Pre-Commit Workflow](#the-one-click-pre-commit-workflow)
25-
- [A Focus on Quality and Productivity](#a-focus-on-quality-and-productivity)
26-
- [The Cost of Stale Documentation](#the-cost-of-stale-documentation)
27-
- [The Power of Workflow Scripts](#the-power-of-workflow-scripts)
28-
- [📦 Release & Versioning](#-release--versioning)
29-
- [How it Works](#how-it-works)
30-
- [Creating a New Release](#creating-a-new-release)
31-
- [Your First Release](#your-first-release)
32-
- [📁 Project Structure](#-project-structure)
33-
- [✍️ Linting for Documentation](#-linting-for-documentation)
34-
- [How to Check for Missing Documentation](#how-to-check-for-missing-documentation)
35-
- [Example](#example)
36-
- [🤝 Contributing](#-contributing)
37-
- [🗺️ Roadmap](#-roadmap)
38-
- [⚖️ Code of Conduct](#-code-of-conduct)
39-
- [🙏 Acknowledgements](#-acknowledgements)
40-
- [👨‍💻 About the Author](#-about-the-author)
41-
- [📄 License](#-license)
12+
- [WordPress Theme PHP Files Generator](#wordpress-theme-php-files-generator)
13+
- [📚 Table of Contents](#-table-of-contents)
14+
- [✨ Key Features](#-key-features)
15+
- [🚀 Getting Started](#-getting-started)
16+
- [Prerequisites](#prerequisites)
17+
- [Installation](#installation)
18+
- [Quick demo](#quick-demo)
19+
- [🚀 Usage](#-usage)
20+
- [`build` Command](#build-command)
21+
- [`new` Command](#new-command)
22+
- [🚀 Available Scripts](#-available-scripts)
23+
- [Automated Documentation](#automated-documentation)
24+
- [Code Quality \& Formatting](#code-quality--formatting)
25+
- [Core Development](#core-development)
26+
- [The "One-Click" Pre-Commit Workflow](#the-one-click-pre-commit-workflow)
27+
- [A Focus on Quality and Productivity](#a-focus-on-quality-and-productivity)
28+
- [The Cost of Stale Documentation](#the-cost-of-stale-documentation)
29+
- [The Power of Workflow Scripts](#the-power-of-workflow-scripts)
30+
- [📦 Release \& Versioning](#-release--versioning)
31+
- [How it Works](#how-it-works)
32+
- [Creating a New Release](#creating-a-new-release)
33+
- [Your First Release](#your-first-release)
34+
- [📁 Project Structure](#-project-structure)
35+
- [✍️ Linting for Documentation](#️-linting-for-documentation)
36+
- [How to Check for Missing Documentation](#how-to-check-for-missing-documentation)
37+
- [Example](#example)
38+
- [🤝 Contributing](#-contributing)
39+
- [🗺️ Roadmap](#️-roadmap)
40+
- [⚖️ Code of Conduct](#️-code-of-conduct)
41+
- [🙏 Acknowledgements](#-acknowledgements)
42+
- [👨‍💻 About the Author](#-about-the-author)
43+
- [📄 License](#-license)
4244

4345
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
4446

@@ -313,15 +315,12 @@ For more details, refer to the [release-please documentation](https://github.com
313315

314316
```plaintext
315317
.
316-
├── -p/
317-
318318
├── .github/ # GitHub Actions workflows
319319
│ └── workflows/
320320
│ ├── ci.yml # Continuous Integration (CI) workflow
321321
│ ├── publish.yml
322322
│ └── release-please.yml
323323
├── .qodo/
324-
325324
├── demo/
326325
│ ├── mytheme/
327326
│ │ ├── footer.php
@@ -357,7 +356,6 @@ For more details, refer to the [release-please documentation](https://github.com
357356
├── package.json # Project metadata and dependencies
358357
└── README.md # This file
359358
```
360-
361359
<!-- END PROJECT STRUCTURE -->
362360

363361
## ✍️ Linting for Documentation

0 commit comments

Comments
 (0)