Permalink
Browse files

Add a readme for GitHub. This is just a stub; people who want to use …

…the library should read the relevant blog post.
  • Loading branch information...
1 parent bbd128d commit 0132961c425cdd8bddc57b26164aae8bd38fbc6e @YahnisElsts committed Nov 6, 2012
Showing with 8 additions and 0 deletions.
  1. +8 −0 README.md
View
@@ -0,0 +1,8 @@
+Plugin Update Checker
+=====================
+
+This is a custom update checker library for WordPress plugins. It lets you add automatic update notifications and one-click upgrades to your commercial and private plugins. All you need to do is put your plugin details in a JSON file, place the file on your server, and pass the URL to the library. The library periodically checks the URL to see if there's a new version available and displays an update notification to the user if necessary.
+
+From the users' perspective, it works just like with plugins hosted on WordPress.org. The update checker uses the default plugin upgrade UI that will already be familiar to most WordPress users.
+
+[See this blog post](http://w-shadow.com/blog/2010/09/02/automatic-updates-for-any-plugin/) for more information and usage instructions.

0 comments on commit 0132961

Please sign in to comment.