Permalink
Browse files

Updating readme

  • Loading branch information...
1 parent 3b9b4ee commit c9e70dcc0778e628d79d2b7249027495d62c3ff2 @andrewhayward committed Jan 16, 2013
Showing with 24 additions and 2 deletions.
  1. +24 −2 README.md
View
@@ -1,4 +1,26 @@
-shortbread
+Shortbread
==========
-A short URL plugin for Wordpress.
+A self-hosted short URL plugin for Wordpress.
+
+
+
+Installation
+------------
+
+Drop the `shortbread` folder into `wp-content/plugins`, and activate through the admin interface. Like you do.
+
+Configure *Shortbread* under `Settings > Short URLs`. Yes, it would arguably make more sense to put these settings on the Permalink page, but given that there's been a bug [1] open about that for four years now, it'll just have to wait.
+
+
+[1] http://core.trac.wordpress.org/ticket/9296
+
+
+
+License
+-------
+
+As per WordPress's thoughts on the matter, this plugin is released under the GPL [2].
+
+
+[2] http://www.gnu.org/licenses/gpl.html

0 comments on commit c9e70dc

Please sign in to comment.