Boilerplate USAGE.md; Update README.md

Author: jedrzejchalubek

README.md

@@ -0,0 +1,110 @@
+# Introduction
+
+## Requirements
+
+Make sure you have all these dependences installed before moving on:
+
+- PHP >= 5.6
+- [Composer](https://getcomposer.org)
+- [Node.js](https://nodejs.org)
+
+# Installation
+
+## Creating new Theme
+
+Create project via `composer create-project` composer command.
+
+```bash
+$ composer create-project tonik/theme <theme-name>
+```
+
+You can also directly download or clone repository to the `wp-content/themes` directory.
+
+```bash
+# Clone repository to the <theme-name> folder.
+$ git clone [email protected]:tonik/theme.git <theme-name>
+```
+
+## Resolving Dependences
+
+Install backend dependeces and generate autoloading file.
+
+```bash
+# Install composer dependences.
+$ composer install
+```
+
+Install frontend dependences and task runner.
+
+```bash
+# Install node dependences.
+$ npm install
+```
+
+# Development
+
+## Compiling Assets
+
+Theme uses [Laravel Elixir](https://laravel.com/docs/5.3/elixir) to compile it's scripts and stylesheets. Files are generated to the `public` directory.
+
+```bash
+# Run compile tasks.
+$ gulp
+
+# Watch for file changes and rund compile tasks.
+$ gulp watch
+
+# Compile assets for production.
+$ gulp --production
+```
+
+## Folders and Files Structure
+
+This starter theme introduces "easy to follow" folder structure, which enforce to divide your theme logic into components.
+
+```
+theme
+    ├── bootstrap/
+    ├── config/
+    │   ├── theme.php
+    ├── public/
+    │   ├── js
+    │   ├── css
+    │   ├── images
+    │   ├── fonts
+    ├── resources/
+    │   ├── assets
+    │   │   ├── js
+    │   │   ├── sass
+    │   ├── templates
+    ├── src/
+    │   ├── Http/
+    │   │   ├── ajaxes.php
+    │   │   ├── assets.php
+    │   ├── Setup/
+    │   │   ├── actions.php
+    │   │   ├── filters.php
+    │   │   ├── navs.php
+    │   │   ├── shortcodes.php
+    │   │   ├── sidebars.php
+    │   │   ├── supports.php
+    │   │   ├── widgets.php
+    │   ├── Structure/
+    │   │   ├── posttypes.php
+    │   │   ├── taxonomies.php
+    │   ├── helpers.php
+    ├── 404.php
+    ├── composer.json
+    ├── footer.php
+    ├── functions.php
+    ├── gin
+    ├── header.php
+    ├── index.php
+    ├── package.json
+    ├── screenshot.png
+    ├── style.css
+```
+
+## USAGE.md Boilerplate
+
+[USAGE.md](https://github.com/tonik/theme/blob/master/USAGE.md) provides "How to use" guide for themes created with this starter. Remember to properly fill this file before finalising project. Your clients will be grateful.

USAGE.md

@@ -0,0 +1,39 @@
+# Theme Installation and Usage
+
+You should be familiar with command line to efficiently install this theme. Required is also a knowledge about [Composer](https://getcomposer.org) and other modern web development tools and workflows.
+
+## Requirements
+
+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
+
+## Bootstraping Theme
+
+Download or clone theme repository to the `wp-content/themes` directory.
+
+```bash
+# @ /wp-content/themes
+# Clone repository to the themes folder.
+$ git clone [email protected]:<repository>/<theme-name>.git <theme-name>
+```
+
+Go into theme directory and resolve Composer dependeces and generate autoloading file.
+
+```bash
+# @ /wp-content/themes
+# Change directory to the cloned folder.
+$ cd <theme-name>
+
+# @ /wp-content/themes/<theme-name>
+# Install required composer dependences (without these needed only to development).
+$ composer install -o --no-devs
+```
+
+## Required Plugins
+
+Here is list of theme's required plugins. They can be installed via "Plugins" dashboard or manualy uploaded to the `wp-content/plugins` directory.
+
+- plugin-name ([plugin-url](#plugin-url))
+- ...

composer.json

@@ -5,17 +5,11 @@
     "license": "GPL-2.0+",
     "type": "wordpress-theme",
     "require": {
-        "php": ">=5.4",
-        "tonik/gin": "@dev"
+        "php": ">=5.6",
+        "tonik/gin": "^1.0.0"
     },
     "require-dev": {
         "symfony/console": "~2.3|~3.0"
     },
-    "repositories": [
-        {
-          "type": "vcs",
-          "url": "/Users/jedrzejchalubek/Code/tonik/gin"
-        }
-    ],
     "minimum-stability": "dev"
 }