Browse files

Merge pull request #12 from danyork/8-docs

Fixed issue #8 - doc changes: 'custom' themes, spacing consistency
  • Loading branch information...
2 parents 29a4053 + 32b1e29 commit 83d437edafa3e3de05c78b0267d59f6299407a5c @conover conover committed Feb 15, 2012
Showing with 7 additions and 7 deletions.
  1. +7 −7 readme.markdown
View
14 readme.markdown
@@ -1,8 +1,8 @@
# Wordpress plugin: a theme updater for GitHub-hosted Wordpress themes
-Do you wish that you could somehow get update notifications within WordPress for _private_ themes that you use for your site? Perhaps a theme that you had developed specifically for your site? Or a theme you developed for a client site? And do you wish you could do "automatic updates" to those private themes just like you can for _public_ themes available from WordPress.org?
+Do you wish that you could somehow get update notifications within WordPress for _custom_ themes that you use for your site? Perhaps a custom theme that you had developed specifically for your site? Or a theme you developed for a client site? And do you wish you could do "automatic updates" to those custom themes just like you can for _public_ themes available from WordPress.org?
-This WordPress plugin lets you host a theme in a Github _public_ repository (private repos are not supported) and then notify sites when a new version of the theme is available. Those sites can then perform an auto-update just as with publicly available themes. The plugin also allows you to roll back to a previous version of the theme.
+This WordPress plugin lets you host a custom theme in a Github _public_ repository (private repos are not supported) and then notify sites when a new version of the theme is available. Those sites can then perform an auto-update just as with publicly available themes. The plugin also allows you to roll back to a previous version of the theme.
This plugin works with WordPress in both a standalone and MultiSite mode and has been tested up to WordPress 3.3.x. It can be found in the WordPress plugin directory at:
@@ -28,9 +28,9 @@ Bugs, feature requests or other suggestions should be filed as [issues at the pl
[Here](https://github.com/UCF/Theme-Updater-Demo) is a sample theme. [Download (.zip)](https://github.com/UCF/Theme-Updater-Demo/zipball/v1.1.0)
-### 1- Publish your theme to a public GitHub Repository
+### 1 - Publish your theme to a public GitHub Repository
-### 2- Update Your theme's `style.css`
+### 2 - Update Your theme's `style.css`
Add `Github Theme URI` to your `style.css` header, this will be where the plugin looks for updates. I also recommend using [semantic versioning](http://semver.org/) for the version number. (Note that the version number does _not_ need to start with "v" as shown in the examples below. You can simply use a number such as "1.2.0". You just need to be consistent with how you create version numbers.)
@@ -45,14 +45,14 @@ Example header:
Push these changes back to the project.
-### 3- Create a new tag and push the change back to the repo
+### 3 - Create a new tag and push the change back to the repo
$ git tag v1.0.0
$ git push origin v1.0.0
Note, your tag numbers and theme version numbers should match. If you want to increment the version number, be sure to update and commit your `style.css` prior to creating the new git tag.
-### 4- Upload your modified theme to your WordPress site
+### 4 - Upload your modified theme to your WordPress site
Before the plugin can work, your theme with the `Github Theme URI` addition needs to be uploaded to our WordPress site.
@@ -62,7 +62,7 @@ Before the plugin can work, your theme with the `Github Theme URI` addition need
Your theme will now be installed inside of WordPress and can be activated for your site. From this point forward all updates will be installed automatically once the plugin is activated.
-### 5- Download and install the plugin
+### 5 - Download and install the plugin
Inside your WordPress admin menu (standalone) or network admin menu (MultiSite) choose "Add New" under the Plugins menu. Search for "Theme Updater" and this will bring you to [the plugin's WordPress page](http://wordpress.org/extend/plugins/theme-updater/) where you can install the plugin directly into your WordPress installation. (Alternatively you can visit that page, download the plugin as a zip file and upload it to your WordPress install, but why go through all that work?)

0 comments on commit 83d437e

Please sign in to comment.