Skip to content

Commit 16b720c

Browse files
committed
Update readme
1 parent 0421ad9 commit 16b720c

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,20 @@
66
</a>
77
</p>
88

9-
**Base** is a WordPress starter theme built with our proven methodology for developing custom WordPress themes. It leverages **Advanced Custom Fields PRO (ACF PRO)** for flexible content management and rapid development.
10-
9+
> ⚠️ **This project is a Work in Progress (WIP).** Expect ongoing updates and improvements.
1110
12-
## Required WordPress plugins
11+
**Base** is a WordPress starter theme built with our proven methodology for developing custom WordPress themes. It leverages **Advanced Custom Fields PRO (ACF PRO)** for flexible content management and rapid development.
1312

14-
- Advanced Custom Field PRO
13+
## 1. Required Plugins
1514

16-
## 🔧 Required Plugins
1715
Ensure the following plugin is installed and activated:
16+
1817
- **Advanced Custom Fields PRO**
1918

20-
## 🌟 Recommended Plugins
19+
## 2. Recommended Plugins
20+
2121
For an enhanced development experience, we recommend the following plugins:
22+
2223
- [**Breadcrumb NavXT**](https://wordpress.org/plugins/breadcrumb-navxt/) – Manage breadcrumbs easily
2324
- [**Classic Editor**](https://wordpress.org/plugins/classic-editor/) – Revert to the classic WordPress editor
2425
- [**Contact Form 7**](https://wordpress.org/plugins/contact-form-7/) – Simple, customizable contact forms
@@ -27,19 +28,19 @@ For an enhanced development experience, we recommend the following plugins:
2728
- [**The SEO Framework**](https://wordpress.org/plugins/autodescription/) – Lightweight and reliable SEO solution
2829

2930

30-
## ⚙️ Preferred Settings
31+
## 3. Preferred Settings
3132

32-
### The SEO Framework Configuration
33+
### 3.1. The SEO Framework Configuration
3334
- Navigate to **Settings → Title Settings → Prefixes**
3435
- Enable: **"Remove term type prefixes from generated archive titles"**
3536

36-
## Image Sizes
37+
### 3.2. Image Sizes
3738

3839
- Thumbnail: 600x600 (no hard-crop)
3940
- Medium: 900x900
4041
- Large: 1400x1400
4142

42-
## Development environment
43+
## 4. Development environment
4344

4445
The project uses npm script to compile Sass. For more details, see: `package.json`.
4546

@@ -50,6 +51,6 @@ To compile the `.scss` files, do the following:
5051

5152
Before release run `npm run prod`-t to compress the files.
5253

53-
## Linters
54+
### 4.1. Linters
5455

5556
The project uses [Stylelint](https://stylelint.io/) and [Semistandard](https://github.com/standard/semistandard). For more information, check out the config files.

0 commit comments

Comments
 (0)