Skip to content

Commit 5c9145b

Browse files
committed
Updated wiki links
1 parent 14cb14a commit 5c9145b

File tree

2 files changed

+19
-53
lines changed

2 files changed

+19
-53
lines changed

README.md

Lines changed: 11 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
## Description
88

9-
This is a boilerplate WordPress plugin featuring namespace autoloading and integration with [Carbon Fields](https://github.com/htmlburger/carbon-fields). It is intended to be used as a starting point for creating quick WordPress plugins. It contains several examples and dependencies to get you started.
9+
This is a boilerplate WordPress plugin featuring namespace autoloading and integration with [Carbon Fields](https://github.com/htmlburger/carbon-fields). It is intended to be used as a starting point for creating WordPress plugins. It contains several examples and dependencies to get you started.
1010

1111
It may also be used as the means of [separating custom code](http://www.billerickson.net/core-functionality-plugin/) from the theme.
1212

@@ -16,7 +16,7 @@ It may also be used as the means of [separating custom code](http://www.billeric
1616
* Version checking (PHP, Carbon Fields)
1717
* Powered by [Composer](https://getcomposer.org/), [Gulp](https://gulpjs.com/) and [Bower](https://bower.io/)
1818
* Object caching (where available; [usage examples](https://github.com/dmhendricks/wordpress-toolkit/wiki/ObjectCache))
19-
* Automatic translation file (`.pot`) creation. See [Translation](https://github.com/dmhendricks/wordpress-base-plugin/wiki#translation).
19+
* Automatic translation file (`.pot`) creation. See [Translation](https://github.com/dmhendricks/wordpress-base-plugin/wiki/Translation).
2020
* Shortcodes, widgets and custom post type (via [PostTypes](https://github.com/jjgrainger/PostTypes/)) examples
2121
* Configuration registry ([docs](https://github.com/dmhendricks/wordpress-toolkit/wiki/ConfigRegistry)) and optional `wp-config.php` [Constants](https://github.com/dmhendricks/wordpress-base-plugin/wiki/Configuration-&-Constants)
2222
* [More to come...](#planned-features)
@@ -28,46 +28,27 @@ It may also be used as the means of [separating custom code](http://www.billeric
2828

2929
* WordPress 4.0 or higher
3030
* PHP 5.6 or higher
31-
* [Carbon Fields](https://github.com/htmlburger/carbon-fields) 2.0 or higher (see [here](https://github.com/dmhendricks/wordpress-base-plugin/wiki#carbon-fields) for more info)
31+
* [Carbon Fields](https://github.com/htmlburger/carbon-fields) 2.0 or higher (see the wiki section [Carbon Fields](https://github.com/dmhendricks/wordpress-base-plugin/wiki#carbon-fields) for more info)
3232

3333
## Installation
3434

35-
If you need tips on installing Node.js, Composer, Gulp & Bower, see [Installing Dependencies](https://github.com/dmhendricks/wordpress-base-plugin/wiki#installing-dependencies).
35+
If you need tips on installing Node.js, Composer, Gulp & Bower, see [Installing Dependencies](https://github.com/dmhendricks/wordpress-base-plugin/wiki/Installing-Dependencies).
3636

3737
### Clone Repository
3838

3939
1. At command prompt, change to your `wp-content/plugins` directory.
40-
1. Close the repository: `git clone https://github.com/dmhendricks/wordpress-base-plugin.git`
41-
42-
### Composer
43-
44-
1. Modify `composer.json` to suit your needs.
45-
1. Run `composer install` to install dependencies and autoload namespace.
46-
47-
If you want to install Carbon Fields as a [dependency](https://github.com/dmhendricks/wordpress-base-plugin/wiki#carbon-fields) rather than via a [loader plugin](https://github.com/dmhendricks/carbon-fields-loader):
48-
49-
```
50-
$ composer require htmlburger/carbon-fields
51-
```
40+
1. Clone the repository: `git clone https://github.com/dmhendricks/wordpress-base-plugin.git`
41+
1. Renamed the newly created `wordpress-base-plugin` directory to your own plugin slug.
5242

5343
### Next Steps
5444

5545
See the [Getting Started](https://github.com/dmhendricks/wordpress-base-plugin/wiki#getting-started) documentation for further steps.
5646

57-
## Plugin Settings
58-
59-
This plugin loads many of its defaults & settings from `plugin.json`. See [Configuration & Constants](https://github.com/dmhendricks/wordpress-base-plugin/wiki/Configuration-&-Constants#pluginjson) for more information.
60-
6147
## Planned Features & TODO
6248

63-
#### 0.3.0 Pre-Release
64-
65-
* Add gulp task to package plugin as ZIP file
66-
67-
#### Future Releases
68-
6949
* Add Customizer example
7050
* Add dynamically-created CSS/JS files based on settings
51+
* Add encrypted text field example
7152

7253
## Change Log
7354

@@ -77,18 +58,19 @@ Release changes are noted on the [Releases](https://github.com/dmhendricks/wordp
7758

7859
* Bumped minimum PHP version check to 5.6
7960
* Added [Gulp](https://gulpjs.com/) for task automation (SASS, JS processing)
80-
* Added `gulp rename` task ([notes](https://github.com/dmhendricks/wordpress-base-plugin/wiki#rename-files-and-strings))
61+
* Added `gulp rename` task ([notes](https://github.com/dmhendricks/wordpress-base-plugin/wiki#node-packages--renaming-stringsfiles))
8162
* Added [Bower](https://bower.io/) to (optionally) load third-party scripts
8263
* Drastically refactored configuration management
8364
* Split out settings pages, shortcodes, CPT & widgets into separate files/classes (thanks [obstschale](https://github.com/obstschale/wordpress-base-plugin))
8465
* Added `wp-pot-cli` to `package.json` to create `.pot` translation file
66+
* Added `npm run zip` to package plugin as ZIP file
8567
* Added `register_uninstall_hook` to delete Carbon Fields settings when plugin uninstalled
68+
* Added Ajax example "Clear Cache" link to admin bar dropdown
8669
* Added [wordpress-settings-api-class](https://github.com/tareq1988/wordpress-settings-api-class) settings page example
8770
* Added `WPTK_DISABLE_CACHE` constant
88-
* Added `VERSION` constant ([info](https://github.com/dmhendricks/wordpress-base-plugin/wiki/Configuration-&-Constants#defined-by-plugin))
71+
* Added `VERSION` constant ([info](https://github.com/dmhendricks/wordpress-base-plugin/wiki/Configuration-&-Constants))
8972
* Added [wordpress-toolkit](https://github.com/dmhendricks/wordpress-toolkit) as dependency
9073
* Renamed `Utils` class to `Helpers`
91-
* Added Ajax example "Clear Cache" link to admin bar dropdown
9274

9375
## Credits
9476

@@ -118,14 +100,6 @@ Please support [humans.txt](http://humanstxt.org/). It's an initiative for knowi
118100
Author URI: https://jjgrainger.co.uk/
119101
Location: Falmouth, England
120102

121-
**WordPress Settings API Class**
122-
123-
URL: https://github.com/tareq1988/wordpress-settings-api-class
124-
Author: Tareq Hasan
125-
Twitter: @tareq_cse
126-
Author URI: https://tareq.co/
127-
Location: Dhaka, Bangladesh
128-
129103
## Screenshot
130104

131105
![Settings Page](https://raw.githubusercontent.com/dmhendricks/wordpress-base-plugin/master/assets/screenshot-1.png "Settings Page")

readme.txt

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,39 +8,31 @@ Stable tag: 0.3.0
88
License: GPL-2.0
99
License URI: http://www.gnu.org/licenses/gpl-2.0.html
1010

11-
This plugin is intended to be used as a boilerplate for creating quick WordPress plugins.
11+
This plugin is intended to be used as a boilerplate for creating WordPress plugins.
1212

1313
== Description ==
1414
This is a boilerplate WordPress plugin featuring namespace autoloading and integration with [Carbon Fields](https://github.com/htmlburger/carbon-fields).
1515

16-
It is intended to be used as a starting point for quickly creating WordPress plugins.
16+
It is intended to be used as a starting point for creating WordPress plugins.
1717

1818
= Requirements =
1919

2020
* WordPress 4.0 or higher
2121
* PHP 5.6 or higher
22-
* [Carbon Fields](https://github.com/htmlburger/carbon-fields) 2.0 or higher (see [Dependencies](https://github.com/dmhendricks/wordpress-base-plugin/wiki#dependencies) for more info)
22+
* [Carbon Fields](https://github.com/htmlburger/carbon-fields) 2.0 or higher (see the wiki section on [Carbon Fields](https://github.com/dmhendricks/wordpress-base-plugin/wiki#carbon-fields) for more info)
2323

2424
== Installation ==
25-
26-
= Zip File =
27-
28-
1. Download the ZIP distribution from Github.
29-
2. Extract to your plugin folder.
30-
3. Configure & run Composer.
25+
If you need tips on installing Node.js, Composer, Gulp & Bower, see [Installing Dependencies](https://github.com/dmhendricks/wordpress-base-plugin/wiki/Installing-Dependencies).
3126

3227
= Clone Repository =
3328

3429
1. At command prompt, change to your `wp-content/plugins` directory.
35-
2. Close the repository: `git clone https://github.com/dmhendricks/wordpress-base-plugin.git`
36-
3. Configure & run Composer.
37-
38-
= Composer =
30+
2. Clone the repository: `git clone https://github.com/dmhendricks/wordpress-base-plugin.git`
31+
3. Renamed the newly created `wordpress-base-plugin` directory to your own plugin slug.
3932

40-
Once you have the source files:
33+
= Next Steps =
4134

42-
1. Modify `composer.json` to suit your needs
43-
2. Run `composer install` to install dependencies and autoload namespace
35+
See the [Getting Started](https://github.com/dmhendricks/wordpress-base-plugin/wiki#getting-started) documentation for further steps.
4436

4537
== Frequently Asked Questions ==
4638
= Q. Why do I get the error "Warning: require( ... /autoload.php): failed to open stream: No such file or directory" when I try to activate it?

0 commit comments

Comments
 (0)