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

Commit

Permalink
Update usage markdown file
Browse files Browse the repository at this point in the history
  • Loading branch information
jedrzejchalubek committed Jul 1, 2017
1 parent 4269013 commit d012423
Showing 1 changed file with 16 additions and 8 deletions.
24 changes: 16 additions & 8 deletions USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,24 @@ You should be familiar with the command line to efficiently install this theme.

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

- At least PHP >= 5.6 (PHP >= 7.0 is recommended)
- WordPress 4.4
- At least PHP >= 7.0
- MySQL >=5.6 or MariaDB >=10.0
- The mod_rewrite Apache module

Make sure you have all these dependences installed before moving on:

- WordPress >= 4.7
- Composer
- Node.js

## Dependences

Theme is based on [Tonik WordPress Starter Theme](https://github.com/tonik/tonik) and requires this dependencies to operate:
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.

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

## Bootstrapping Theme
## Installation

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

Expand Down Expand Up @@ -49,11 +57,11 @@ $ npm run prod

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.

- plugin-name ([plugin-url](#plugin-url))
- <plugin-name> ([plugin-url](#plugin-url))
- ...

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

```
wp plugin install plugin-name --activate
```
wp plugin install <plugin-name> --activate
```

0 comments on commit d012423

Please sign in to comment.