Skip to content
This repository was archived by the owner on Nov 14, 2024. It is now read-only.

Commit d012423

Browse files
Update usage markdown file
1 parent 4269013 commit d012423

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

USAGE.md

+16-8
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,24 @@ You should be familiar with the command line to efficiently install this theme.
66

77
This theme follow WordPress [recommended requirments](https://wordpress.org/about/requirements). Your server must fulfill requirements:
88

9-
- At least PHP >= 5.6 (PHP >= 7.0 is recommended)
10-
- WordPress 4.4
9+
- At least PHP >= 7.0
10+
- MySQL >=5.6 or MariaDB >=10.0
11+
- The mod_rewrite Apache module
12+
13+
Make sure you have all these dependences installed before moving on:
14+
15+
- WordPress >= 4.7
16+
- Composer
17+
- Node.js
1118

1219
## Dependences
1320

14-
Theme is based on [Tonik WordPress Starter Theme](https://github.com/tonik/tonik) and requires this dependencies to operate:
21+
Theme is based on [Tonik WordPress Starter Theme](https://github.com/tonik/theme). It has a few PHP dependencies, they are extracted to separate packages for easy installation and managing via Composer.
1522

16-
- [tonik/gin](https://github.com/tonik/gin) package >= 2.0.0
23+
- [tonik/gin](https://github.com/tonik/gin) (required) - Theme foundation which provides all custom functionalities
24+
- [tonik/cli](https://github.com/tonik/cli) (optional) - Simple CLI for initiating theme
1725

18-
## Bootstrapping Theme
26+
## Installation
1927

2028
Download or clone theme repository to the `wp-content/themes` directory.
2129

@@ -49,11 +57,11 @@ $ npm run prod
4957

5058
Here is a list of theme's required and recommended plugins. They can be installed via "Plugins" dashboard or manually uploaded to the `wp-content/plugins` directory.
5159

52-
- plugin-name ([plugin-url](#plugin-url))
60+
- <plugin-name> ([plugin-url](#plugin-url))
5361
- ...
5462

5563
Familiar with WP-CLI? Install plugins via command line:
5664

5765
```
58-
wp plugin install plugin-name --activate
59-
```
66+
wp plugin install <plugin-name> --activate
67+
```

0 commit comments

Comments
 (0)