Merge branch 'feature-readme'

Author: athlan

README.md

@@ -0,0 +1,51 @@
+# Custom Fields Permalink 2
+
+Plugin allows to use post's custom fields values in permalink structure by adding %field_fieldname%, for posts, pages and custom post types.
+
+---
+
+* Contributors: <a href="https://github.com/athlan">athlan</a>
+* Plugin url: [http://athlan.pl/wordpres-custom-fields-permalink-plugin/](http://athlan.pl/wordpres-custom-fields-permalink-plugin/)
+* Tags: custom fields, permalinks, permalink, url, custom post types, post type, tax, taxonomy, types
+* Requires at least: 3.0.0
+* Tested up to: 3.9.1
+* Stable tag: 1.0
+* License: MIT
+* License URI: http://opensource.org/licenses/MIT
+
+## Description
+
+Plugin allows to use post's custom fields values in permalink structure by adding `%field_fieldname%` rewrite tag.
+
+Examples:
+
+* `http://example.com/%field_event_date_from%/%postname%/`
+* `http://example.com/post-type/%field_event_date_from%/%postname%/` (with <a href="https://wordpress.org/plugins/custom-post-type-permalinks/">Custom Post Type Permalinks</a> plugin)
+
+You can also set different permalink structure depending on custom post type using <a href="https://wordpress.org/plugins/custom-post-type-permalinks/">Custom Post Type Permalinks</a> plugin. You can create own post types by using <a href="https://wordpress.org/plugins/custom-post-type-ui/">Custom Post Type UI</a> plugin.
+
+The plugin works for:
+
+* posts
+* pages
+* custom post types
+
+Plugin is also avaliable on GitHub:
+<a href="https://github.com/athlan/wordpress-custom-fields-permalink-plugin">https://github.com/athlan/wordpress-custom-fields-permalink-plugin</a>
+
+## Installation
+
+* Download the wordpress-custom-fields-permalink-plugin.zip file to your computer.
+* Unzip the file.
+* Upload the `wordpress-custom-fields-permalink-plugin` directory to your `/wp-content/plugins/` directory.
+* Activate the plugin through the 'Plugins' menu in WordPress.
+* Now you can use `%field_fieldname%` tag in Settings -> Permalinks.
+
+## Changelog
+
+### 1.0
+* Plugin released.
+
+## Upgrade Notice
+
+No upgrade notices.

assets/screenshot-1.png

@@ -0,0 +1,62 @@
+=== Custom Fields Permalink 2 ===
+Contributors: athlan
+Donate link: http://athlan.pl/wordpres-custom-fields-permalink-plugin/
+Tags: custom fields, permalinks, permalink, url, custom post types, post type, tax, taxonomy, types
+Requires at least: 3.0.0
+Tested up to: 3.9.1
+Stable tag: 1.0
+License: MIT
+License URI: http://opensource.org/licenses/MIT
+
+Plugin allows to use post's custom fields values in permalink structure by adding %field_fieldname%, for posts, pages and custom post types.
+
+== Description ==
+
+Plugin allows to use post's custom fields values in permalink structure by adding `%field_fieldname%` rewrite tag.
+
+Examples:
+
+* `http://example.com/%field_event_date_from%/%postname%/`
+* `http://example.com/post-type/%field_event_date_from%/%postname%/` (with <a href="https://wordpress.org/plugins/custom-post-type-permalinks/">Custom Post Type Permalinks</a> plugin)
+
+You can also set different permalink structure depending on custom post type using <a href="https://wordpress.org/plugins/custom-post-type-permalinks/">Custom Post Type Permalinks</a> plugin. You can create own post types by using <a href="https://wordpress.org/plugins/custom-post-type-ui/">Custom Post Type UI</a> plugin.
+
+The plugin works for:
+
+* posts
+* pages
+* custom post types
+
+Plugin is also avaliable on GitHub:
+<a href="https://github.com/athlan/wordpress-custom-fields-permalink-plugin">https://github.com/athlan/wordpress-custom-fields-permalink-plugin</a>
+
+== Installation ==
+
+* Download the wordpress-custom-fields-permalink-plugin.zip file to your computer.
+* Unzip the file.
+* Upload the `wordpress-custom-fields-permalink-plugin` directory to your `/wp-content/plugins/` directory.
+* Activate the plugin through the 'Plugins' menu in WordPress.
+* Now you can use `%field_fieldname%` tag in Settings -> Permalinks.
+
+== Frequently Asked Questions ==
+
+= A question that someone might have =
+
+An answer to that question.
+
+= What about foo bar? =
+
+Answer to foo bar dilemma.
+
+== Screenshots ==
+
+1. Pemralink settings
+
+== Changelog ==
+
+= 1.0 =
+* Plugin released.
+
+== Upgrade Notice ==
+
+No upgrade notices.

readme.txt

@@ -1,8 +1,8 @@
 <?php
 /*
 Plugin Name: Custom Fields Permalink 2
-Plugin URI: http://athlan.pl/custom-fields-permalink
-Description: This plugin enable to make a permalink from custom field's value.
+Plugin URI: http://athlan.pl/wordpress-custom-fields-permalink-plugin
+Description: Plugin allows to use post's custom fields values in permalink structure by adding %field_fieldname%, for posts, pages and custom post types.
 Author: Piotr Pelczar
 Version: 2.0
 Author URI: http://athlan.pl/