Skip to content

Commit

Permalink
Prep for 0.1.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
dmhendricks committed Oct 2, 2017
1 parent a518af8 commit 6f55d46
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 13 deletions.
36 changes: 23 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,45 @@
[![Author](https://img.shields.io/badge/author-Daniel%20M.%20Hendricks-blue.svg)](https://www.danhendricks.com)
[![GitHub License](https://img.shields.io/badge/license-GPLv2-green.svg)](https://raw.githubusercontent.com/dmhendricks/wordpress-toolkit/master/LICENSE)
[![Total Downloads](https://img.shields.io/packagist/dt/dmhendricks/wordpress-toolkit.svg)](https://packagist.org/packages/dmhendricks/wordpress-toolkit)
[![Author](https://img.shields.io/badge/author-Daniel%20M.%20Hendricks-lightgrey.svg?colorB=9900cc)](https://www.danhendricks.com)
[![Latest Version](https://img.shields.io/github/release/dmhendricks/wordpress-toolkit.svg)](https://github.com/dmhendricks/wordpress-toolkit/releases)
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://paypal.me/danielhendricks)
[![WP Engine](https://img.shields.io/badge/WP%20Engine-Compatible-orange.svg)](http://bit.ly/WPEnginePlans)
[![GitHub License](https://img.shields.io/badge/license-GPLv2-yellow.svg)](https://raw.githubusercontent.com/dmhendricks/wordpress-toolkit/master/LICENSE)
[![Twitter](https://img.shields.io/twitter/url/https/github.com/dmhendricks/wordpress-toolkit.svg?style=social)](https://twitter.com/danielhendricks)

# WordPress Tool Kit

A growing collection of classes that I use in my WordPress plugins.
A collection of classes that I use in my WordPress projects & plugins.

### Contributing

If you can make the code better or recommend/contribute code that would be useful to include, [please let me know](https://github.com/dmhendricks/wordpress-toolkit/issues).

## Requirements

* WordPress 4.0 or higher
* PHP 5.6 or higher

## Features

* [ConfigRegistry](https://github.com/dmhendricks/wordpress-toolkit/wiki/ConfigRegistry) class - Loads plugin/theme settings from an array or JSON file.
* [ObjectCache](https://github.com/dmhendricks/wordpress-toolkit/wiki/ObjectCache) class - A wrapper for setting/fetching values from the WordPress object cache, where available.
* [ScriptObject](https://github.com/dmhendricks/wordpress-toolkit/wiki/ScriptObject) class - Inject JavaScript variables or CSS into the page head or write/enqueue external files.

## Install with Composer
## Installation

### Requirements

* WordPress 4.0 or higher
* PHP 5.6 or higher

### Install with Composer

```
composer require dmhendricks/wordpress-toolkit
```

## Usage

**Note:** This code is currently in initial, alpha stage.
### Usage

Please see the [Documentation](https://github.com/dmhendricks/wordpress-toolkit/wiki) page.

## Change Log

Release changes are be noted on the [Releases](https://github.com/dmhendricks/wordpress-toolkit/releases) page.

#### Branch: `master`

* None since release
1 change: 1 addition & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "dmhendricks/wordpress-toolkit",
"description": "A collection of helper classes and functions for WordPress plugins and themes.",
"version": "0.1.0",
"license": "GPL-2.0",
"homepage": "https://github.com/dmhendricks/wordpress-toolkit",
"authors": [
Expand Down

0 comments on commit 6f55d46

Please sign in to comment.